| Éric Araujo | 3a9f58f | 2011-06-01 20:42:49 +0200 | [diff] [blame] | 1 | .. _packaging-package-upload: |
| 2 | |
| 3 | *************************************** |
| 4 | Uploading Packages to the Package Index |
| 5 | *************************************** |
| 6 | |
| 7 | The Python Package Index (PyPI) not only stores the package info, but also the |
| 8 | package data if the author of the package wishes to. The packaging command |
| 9 | :command:`upload` pushes the distribution files to PyPI. |
| 10 | |
| 11 | The command is invoked immediately after building one or more distribution |
| 12 | files. For example, the command :: |
| 13 | |
| 14 | python setup.py sdist bdist_wininst upload |
| 15 | |
| 16 | will cause the source distribution and the Windows installer to be uploaded to |
| 17 | PyPI. Note that these will be uploaded even if they are built using an earlier |
| 18 | invocation of :file:`setup.py`, but that only distributions named on the command |
| 19 | line for the invocation including the :command:`upload` command are uploaded. |
| 20 | |
| 21 | The :command:`upload` command uses the username, password, and repository URL |
| 22 | from the :file:`$HOME/.pypirc` file (see section :ref:`packaging-pypirc` for more on this |
| 23 | file). If a :command:`register` command was previously called in the same |
| 24 | command, and if the password was entered in the prompt, :command:`upload` will |
| 25 | reuse the entered password. This is useful if you do not want to store a clear |
| 26 | text password in the :file:`$HOME/.pypirc` file. |
| 27 | |
| 28 | You can specify another PyPI server with the :option:`--repository=*url*` |
| 29 | option:: |
| 30 | |
| 31 | python setup.py sdist bdist_wininst upload -r http://example.com/pypi |
| 32 | |
| 33 | See section :ref:`packaging-pypirc` for more on defining several servers. |
| 34 | |
| 35 | You can use the :option:`--sign` option to tell :command:`upload` to sign each |
| 36 | uploaded file using GPG (GNU Privacy Guard). The :program:`gpg` program must |
| 37 | be available for execution on the system :envvar:`PATH`. You can also specify |
| 38 | which key to use for signing using the :option:`--identity=*name*` option. |
| 39 | |
| 40 | Other :command:`upload` options include :option:`--repository=<url>` or |
| 41 | :option:`--repository=<section>` where *url* is the url of the server and |
| 42 | *section* the name of the section in :file:`$HOME/.pypirc`, and |
| 43 | :option:`--show-response` (which displays the full response text from the PyPI |
| 44 | server for help in debugging upload problems). |
| 45 | |
| 46 | PyPI package display |
| 47 | ==================== |
| 48 | |
| 49 | The ``description`` field plays a special role at PyPI. It is used by |
| 50 | the server to display a home page for the registered package. |
| 51 | |
| 52 | If you use the `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ |
| 53 | syntax for this field, PyPI will parse it and display an HTML output for |
| 54 | the package home page. |
| 55 | |
| 56 | The ``description`` field can be filled from a text file located in the |
| 57 | project:: |
| 58 | |
| 59 | from packaging.core import setup |
| 60 | |
| 61 | fp = open('README.txt') |
| 62 | try: |
| 63 | description = fp.read() |
| 64 | finally: |
| 65 | fp.close() |
| 66 | |
| 67 | setup(name='Packaging', |
| 68 | description=description) |
| 69 | |
| 70 | In that case, :file:`README.txt` is a regular reStructuredText text file located |
| 71 | in the root of the package besides :file:`setup.py`. |
| 72 | |
| 73 | To prevent registering broken reStructuredText content, you can use the |
| 74 | :program:`rst2html` program that is provided by the :mod:`docutils` package |
| 75 | and check the ``description`` from the command line:: |
| 76 | |
| 77 | $ python setup.py --description | rst2html.py > output.html |
| 78 | |
| 79 | :mod:`docutils` will display a warning if there's something wrong with your |
| 80 | syntax. |