| Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 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 | |
| Tarek Ziadé | 1a240fb | 2009-01-08 23:56:31 +0000 | [diff] [blame] | 16 | python setup.py sdist bdist_wininst upload |
| Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 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 |
| Tarek Ziadé | 1a240fb | 2009-01-08 23:56:31 +0000 | [diff] [blame] | 25 | file). If a :command:`register` command was previously called in the same command, |
| 26 | and if the password was entered in the prompt, :command:`upload` will reuse the |
| 27 | entered password. This is useful if you do not want to store a clear text |
| 28 | password in the :file:`$HOME/.pypirc` file. |
| Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 29 | |
| Andrew M. Kuchling | aac5c86 | 2008-05-11 14:00:00 +0000 | [diff] [blame] | 30 | You can specify another PyPI server with the :option:`--repository=*url*` option:: |
| 31 | |
| Tarek Ziadé | 1a240fb | 2009-01-08 23:56:31 +0000 | [diff] [blame] | 32 | python setup.py sdist bdist_wininst upload -r http://example.com/pypi |
| Andrew M. Kuchling | aac5c86 | 2008-05-11 14:00:00 +0000 | [diff] [blame] | 33 | |
| 34 | See section :ref:`pypirc` for more on defining several servers. |
| 35 | |
| Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 36 | You can use the :option:`--sign` option to tell :command:`upload` to sign each |
| 37 | uploaded file using GPG (GNU Privacy Guard). The :program:`gpg` program must |
| 38 | be available for execution on the system :envvar:`PATH`. You can also specify |
| 39 | which key to use for signing using the :option:`--identity=*name*` option. |
| 40 | |
| Georg Brandl | e92818f | 2009-01-03 20:47:01 +0000 | [diff] [blame] | 41 | Other :command:`upload` options include :option:`--repository=<url>` or |
| 42 | :option:`--repository=<section>` where *url* is the url of the server and |
| 43 | *section* the name of the section in :file:`$HOME/.pypirc`, and |
| Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 44 | :option:`--show-response` (which displays the full response text from the PyPI |
| 45 | server for help in debugging upload problems). |