Package distutils :: Package command :: Module register :: Class register

Class register

cmd.Command --+
              |
             register

Instance Methods

[hide private]

initialize_options(self)
Set default values for all the options that this command supports.

finalize_options(self)
Set final values for all the options that this command supports.

run(self)
A command's raison d'etre: carry out the action it exists to perform, controlled by the options initialized in 'initialize_options()', customized by other commands, the setup script, the command-line, and config files, and finalized in 'finalize_options()'.

check_metadata(self)
Ensure that all required elements of meta-data (name, version, URL, (author and author_email) or (maintainer and maintainer_email)) are supplied by the Distribution object; warn if any are missing.

classifiers(self)
Fetch the list of classifiers from the server.

verify_metadata(self)
Send the metadata to the package index server to be checked.

send_metadata(self)
Send the metadata to the package index server.

build_post_data(self, action)

post_to_server(self, data, auth=None)
Post a query to the server, and return a string response.

Inherited from cmd.Command: __getattr__, __init__, announce, copy_file, copy_tree, debug_print, dump_options, ensure_dirname, ensure_filename, ensure_finalized, ensure_string, ensure_string_list, execute, get_command_name, get_finalized_command, get_sub_commands, make_archive, make_file, mkpath, move_file, reinitialize_command, run_command, set_undefined_options, spawn, warn

Inherited from cmd.Command (private): _ensure_stringlike, _ensure_tested_string

Class Variables

[hide private]

description = 'register the distribution with the Python packa...

DEFAULT_REPOSITORY = 'http://www.python.org/pypi'

user_options = [('repository=', 'r', 'url of repository [defau...

boolean_options = ['verify', 'show-response', 'list-classifiers']

Inherited from cmd.Command: sub_commands

Method Details

[hide private]

initialize_options(self)

Set default values for all the options that this command supports. Note that these defaults may be overridden by other commands, by the setup script, by config files, or by the command-line. Thus, this is not the place to code dependencies between options; generally, 'initialize_options()' implementations are just a bunch of "self.foo = None" assignments.

This method must be implemented by all command classes.

Overrides: cmd.Command.initialize_options: (inherited documentation)

finalize_options(self)

Set final values for all the options that this command supports. This is always called as late as possible, ie. after any option assignments from the command-line or from other commands have been done. Thus, this is the place to code option dependencies: if 'foo' depends on 'bar', then it is safe to set 'foo' from 'bar' as long as 'foo' still has the same value it was assigned in 'initialize_options()'.

This method must be implemented by all command classes.

Overrides: cmd.Command.finalize_options: (inherited documentation)

run(self)

A command's raison d'etre: carry out the action it exists to perform, controlled by the options initialized in 'initialize_options()', customized by other commands, the setup script, the command-line, and config files, and finalized in 'finalize_options()'. All terminal output and filesystem interaction should be done by 'run()'.

This method must be implemented by all command classes.

Overrides: cmd.Command.run: (inherited documentation)

send_metadata(self)

Send the metadata to the package index server.

Well, do the following:
1. figure who the user is, and then
2. send the data as a Basic auth'ed POST.

First we try to read the username/password from $HOME/.pypirc,
which is a ConfigParser-formatted file with a section
[server-login] containing username and password entries (both
in clear text). Eg:

    [server-login]
    username: fred
    password: sekrit

Otherwise, to figure who the user is, we offer the user three
choices:

 1. use existing login,
 2. register as a new user, or
 3. set the password to a random string and email the user.

Class Variable Details

[hide private]

description

Value:

'register the distribution with the Python package index'

user_options

Value:

[('repository=',
  'r',
  'url of repository [default: http://www.python.org/pypi]'),
 ('list-classifiers', None, 'list the valid Trove classifiers'),
 ('show-response', None, 'display full response text from server')]