summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSteve Kowalik <steven@wedontsleep.org>2016-02-16 16:01:54 +1100
committerSteve Kowalik <steven@wedontsleep.org>2016-02-16 16:01:54 +1100
commit69175b941a74a4e2f37b856437b3ca20bc2f240a (patch)
treee0349b731b724c76963f9fd429f53b22cbf142d3 /docs
parent43d0308ad6a8c83be645b09e8c1871b36ff3c4c9 (diff)
parent8ccd428cd2a733891bffce13e017774ea82bd8d2 (diff)
downloadpython-setuptools-git-69175b941a74a4e2f37b856437b3ca20bc2f240a.tar.gz
Merge from master, resolving conflicts.
Diffstat (limited to 'docs')
-rw-r--r--docs/setuptools.txt59
1 files changed, 15 insertions, 44 deletions
diff --git a/docs/setuptools.txt b/docs/setuptools.txt
index d6a62de8..610a0e61 100644
--- a/docs/setuptools.txt
+++ b/docs/setuptools.txt
@@ -2328,54 +2328,25 @@ available:
``upload`` - Upload source and/or egg distributions to PyPI
===========================================================
-PyPI now supports uploading project files for redistribution; uploaded files
-are easily found by EasyInstall, even if you don't have download links on your
-project's home page.
+The ``upload`` command is implemented and `documented
+<https://docs.python.org/3.1/distutils/uploading.html>`_
+in distutils.
-Although Python 2.5 will support uploading all types of distributions to PyPI,
-setuptools only supports source distributions and eggs. (This is partly
-because PyPI's upload support is currently broken for various other file
-types.) To upload files, you must include the ``upload`` command *after* the
-``sdist`` or ``bdist_egg`` commands on the setup command line. For example::
+Setuptools augments the ``upload`` command with support
+for `keyring <https://pypi.python.org/pypi/keyring>`_,
+allowing the password to be stored in a secure
+location and not in plaintext in the .pypirc file. To use
+keyring, first install keyring and set the password for
+the relevant repository, e.g.::
- setup.py bdist_egg upload # create an egg and upload it
- setup.py sdist upload # create a source distro and upload it
- setup.py sdist bdist_egg upload # create and upload both
+ python -m keyring set <repository> <username>
+ Password for '<username>' in '<repository>': ********
-Note that to upload files for a project, the corresponding version must already
-be registered with PyPI, using the distutils ``register`` command. It's
-usually a good idea to include the ``register`` command at the start of the
-command line, so that any registration problems can be found and fixed before
-building and uploading the distributions, e.g.::
+Then, in .pypirc, set the repository configuration as normal,
+but omit the password. Thereafter, uploads will use the
+password from the keyring.
- setup.py register sdist bdist_egg upload
-
-This will update PyPI's listing for your project's current version.
-
-Note, by the way, that the metadata in your ``setup()`` call determines what
-will be listed in PyPI for your package. Try to fill out as much of it as
-possible, as it will save you a lot of trouble manually adding and updating
-your PyPI listings. Just put it in ``setup.py`` and use the ``register``
-command to keep PyPI up to date.
-
-The ``upload`` command has a few options worth noting:
-
-``--sign, -s``
- Sign each uploaded file using GPG (GNU Privacy Guard). The ``gpg`` program
- must be available for execution on the system ``PATH``.
-
-``--identity=NAME, -i NAME``
- Specify the identity or key name for GPG to use when signing. The value of
- this option will be passed through the ``--local-user`` option of the
- ``gpg`` program.
-
-``--show-response``
- Display the full response text from server; this is useful for debugging
- PyPI problems.
-
-``--repository=URL, -r URL``
- The URL of the repository to upload to. Defaults to
- https://pypi.python.org/pypi (i.e., the main PyPI installation).
+New in 20.1: Added keyring support.
.. _upload_docs: