l4/pkg/python/contrib/Doc/distutils/uploading.rst

   1 .. _package-upload:
   2
   3 ***************************************
   4 Uploading Packages to the Package Index
   5 ***************************************
   6
   7 .. versionadded:: 2.5
   8
   9 The Python Package Index (PyPI) not only stores the package info, but also  the
  10 package data if the author of the package wishes to. The distutils command
  11 :command:`upload` pushes the distribution files to PyPI.
  12
  13 The command is invoked immediately after building one or more distribution
  14 files.  For example, the command ::
  15
  16    python setup.py sdist bdist_wininst upload
  17
  18 will cause the source distribution and the Windows installer to be uploaded to
  19 PyPI.  Note that these will be uploaded even if they are built using an earlier
  20 invocation of :file:`setup.py`, but that only distributions named on the command
  21 line for the invocation including the :command:`upload` command are uploaded.
  22
  23 The :command:`upload` command uses the username, password, and repository URL
  24 from the :file:`$HOME/.pypirc` file (see section :ref:`pypirc` for more on this
  25 file).
  26
  27 You can specify another PyPI server with the :option:`--repository=*url*` option::
  28
  29    python setup.py sdist bdist_wininst upload -r http://example.com/pypi
  30
  31 See section :ref:`pypirc` for more on defining several servers.
  32
  33 You can use the :option:`--sign` option to tell :command:`upload` to sign each
  34 uploaded file using GPG (GNU Privacy Guard).  The  :program:`gpg` program must
  35 be available for execution on the system :envvar:`PATH`.  You can also specify
  36 which key to use for signing using the :option:`--identity=*name*` option.
  37
  38 Other :command:`upload` options include :option:`--repository=<url>` or
  39 :option:`--repository=<section>` where *url* is the url of the server and
  40 *section* the name of the section in :file:`$HOME/.pypirc`, and
  41 :option:`--show-response` (which displays the full response text from the PyPI
  42 server for help in debugging upload problems).
  43