setuptools._distutils.command.register.register

class documentation

class register(PyPIRCCommand): (source)

Undocumented

Method	`build_post_data`	Undocumented
Method	`check_metadata`	Deprecated API.
Method	`classifiers`	Fetch the list of classifiers from the server.
Method	`finalize_options`	Finalizes options.
Method	`initialize_options`	Initialize options.
Method	`post_to_server`	Post a query to the server, and return a string response.
Method	`run`	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()'...
Method	`send_metadata`	Send the metadata to the package index server.
Method	`verify_metadata`	Send the metadata to the package index server to be checked.
Class Variable	`boolean_options`	Undocumented
Class Variable	`description`	Undocumented
Class Variable	`sub_commands`	Undocumented
Class Variable	`user_options`	Undocumented
Instance Variable	`has_config`	Undocumented
Instance Variable	`list_classifiers`	Undocumented
Instance Variable	`password`	Undocumented
Instance Variable	`realm`	Undocumented
Instance Variable	`repository`	Undocumented
Instance Variable	`strict`	Undocumented
Instance Variable	`username`	Undocumented
Method	`_set_config`	Reads the configuration file and set attributes.

Inherited from PyPIRCCommand:

Constant	`DEFAULT_REALM`	Undocumented
Constant	`DEFAULT_REPOSITORY`	Undocumented
Instance Variable	`show_response`	Undocumented
Method	`_get_rc_file`	Returns rc file path.
Method	`_read_pypi_response`	Read and decode a PyPI HTTP response.
Method	`_read_pypirc`	Reads the .pypirc file.
Method	`_store_pypirc`	Creates a default .pypirc file.

Inherited from Command (via PyPIRCCommand):

Method	`__getattr__`	Undocumented
Method	`__init__`	Create and initialize a new Command object. Most importantly, invokes the 'initialize_options()' method, which is the real initializer and depends on the actual command being instantiated.
Method	`announce`	Undocumented
Method	`copy_file`	Copy a file respecting verbose, dry-run and force flags. (The former two default to whatever is in the Distribution object, and the latter defaults to false for commands that don't define it.)
Method	`copy_tree`	Copy an entire directory tree respecting verbose, dry-run, and force flags.
Method	`debug_print`	Print 'msg' to stdout if the global DEBUG (taken from the DISTUTILS_DEBUG environment variable) flag is true.
Method	`dump_options`	Undocumented
Method	`ensure_dirname`	Undocumented
Method	`ensure_filename`	Ensure that 'option' is the name of an existing file.
Method	`ensure_finalized`	Undocumented
Method	`ensure_string`	Ensure that 'option' is a string; if not defined, set it to 'default'.
Method	`ensure_string_list`	Ensure that 'option' is a list of strings. If 'option' is currently a string, we split it either on /,\s*/ or /\s+/, so "foo bar baz", "foo,bar,baz", and "foo, bar baz" all become ["foo", "bar", "baz"].
Method	`execute`	Undocumented
Method	`get_command_name`	Undocumented
Method	`get_finalized_command`	Wrapper around Distribution's 'get_command_obj()' method: find (create if necessary and 'create' is true) the command object for 'command', call its 'ensure_finalized()' method, and return the finalized command object.
Method	`get_sub_commands`	Determine the sub-commands that are relevant in the current distribution (ie., that need to be run). This is based on the 'sub_commands' class attribute: each tuple in that list may include a method that we call to determine if the subcommand needs to be run for the current distribution...
Method	`make_archive`	Undocumented
Method	`make_file`	Special case of 'execute()' for operations that process one or more input files and generate one output file. Works just like 'execute()', except the operation is skipped and a different message printed if 'outfile' already exists and is newer than all files listed in 'infiles'...
Method	`mkpath`	Undocumented
Method	`move_file`	Move a file respecting dry-run flag.
Method	`reinitialize_command`	Undocumented
Method	`run_command`	Run some other command: uses the 'run_command()' method of Distribution, which creates and finalizes the command object if necessary and then invokes its 'run()' method.
Method	`set_undefined_options`	Set the values of any "undefined" options from corresponding option values in some other command object. "Undefined" here means "is None", which is the convention used to indicate that an option has not been changed between 'initialize_options()' and 'finalize_options()'...
Method	`spawn`	Spawn an external command respecting dry-run flag.
Method	`warn`	Undocumented
Instance Variable	`distribution`	Undocumented
Instance Variable	`finalized`	Undocumented
Instance Variable	`force`	Undocumented
Instance Variable	`help`	Undocumented
Instance Variable	`verbose`	Undocumented
Method	`_ensure_stringlike`	Undocumented
Method	`_ensure_tested_string`	Undocumented
Instance Variable	`_dry_run`	Undocumented

def build_post_data(self, action): (source) ¶

Undocumented

def check_metadata(self): (source) ¶

Deprecated API.

def classifiers(self): (source) ¶

Fetch the list of classifiers from the server.

def finalize_options(self): (source) ¶

overrides setuptools._distutils.core.PyPIRCCommand.finalize_options

Finalizes options.

def initialize_options(self): (source) ¶

overrides setuptools._distutils.core.PyPIRCCommand.initialize_options

Initialize options.

def post_to_server(self, data, auth=None): (source) ¶

Post a query to the server, and return a string response.

def run(self): (source) ¶

overrides setuptools._distutils.core.Command.run

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.

def send_metadata(self): (source) ¶

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 [distutils] containing username and password entries (both in clear text). Eg: [distutils] index-servers = pypi [pypi] 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.

def verify_metadata(self): (source) ¶

Send the metadata to the package index server to be checked.

boolean_options = (source) ¶

overrides setuptools._distutils.core.PyPIRCCommand.boolean_options

Undocumented

description: str = (source) ¶

Undocumented

sub_commands = (source) ¶

overrides setuptools._distutils.core.Command.sub_commands

Undocumented

user_options = (source) ¶

overrides setuptools._distutils.core.PyPIRCCommand.user_options