Skip to content

Commit d7bc161

Browse files
committed
bpo-33071: removed outdated PyPI docs
1 parent d9d1045 commit d7bc161

File tree

2 files changed

+12
-62
lines changed

2 files changed

+12
-62
lines changed

Doc/distutils/packageindex.rst

Lines changed: 10 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,6 @@ The `Python Package Index (PyPI)`_ stores :ref:`meta-data <meta-data>`
1212
describing distributions packaged with distutils, as well as package data like
1313
distribution files if a package author wishes.
1414

15-
Distutils provides the :command:`register` and :command:`upload` commands for
16-
pushing meta-data and distribution files to PyPI, respectively. See
17-
:ref:`package-commands` for information on these commands.
18-
1915

2016
PyPI overview
2117
=============
@@ -26,68 +22,29 @@ and the index will be updated.
2622

2723
PyPI holds a record for each (name, version) combination submitted. The first
2824
user to submit information for a given name is designated the Owner of that
29-
name. Changes can be submitted through the :command:`register` command or
30-
through the web interface. Owners can designate other users as Owners or
31-
Maintainers. Maintainers can edit the package information, but not designate
32-
new Owners or Maintainers.
25+
name. Changes can be submitted through the web interface. Owners can
26+
designate other users as Owners or Maintainers. Maintainers can edit the
27+
package information, but not designate new Owners or Maintainers.
3328

3429
By default PyPI displays only the newest version of a given package. The web
3530
interface lets one change this default behavior and manually select which
3631
versions to display and hide.
3732

3833
For each version, PyPI displays a home page. The home page is created from
39-
the ``long_description`` which can be submitted via the :command:`register`
40-
command. See :ref:`package-display` for more information.
34+
the ``long_description``. See :ref:`package-display` for more information.
4135

4236

4337
.. _package-commands:
4438

4539
Distutils commands
4640
==================
4741

48-
Distutils exposes two commands for submitting package data to PyPI: the
49-
:ref:`register <package-register>` command for submitting meta-data to PyPI
50-
and the :ref:`upload <package-upload>` command for submitting distribution
51-
files. Both commands read configuration data from a special file called a
42+
Distutils exposes a command for submitting package data to PyPI:
43+
the :ref:`upload <package-upload>` command for submitting distribution
44+
files. The command read configuration data from a special file called a
5245
:ref:`.pypirc file <pypirc>`.
5346

5447

55-
.. _package-register:
56-
57-
The ``register`` command
58-
------------------------
59-
60-
The distutils command :command:`register` is used to submit your distribution's
61-
meta-data to an index server. It is invoked as follows::
62-
63-
python setup.py register
64-
65-
Distutils will respond with the following prompt::
66-
67-
running register
68-
We need to know who you are, so please choose either:
69-
1. use your existing login,
70-
2. register as a new user,
71-
3. have the server generate a new password for you (and email it to you), or
72-
4. quit
73-
Your selection [default 1]:
74-
75-
Note: if your username and password are saved locally, you will not see this
76-
menu. Also, refer to :ref:`pypirc` for how to store your credentials in a
77-
:file:`.pypirc` file.
78-
79-
If you have not registered with PyPI, then you will need to do so now. You
80-
should choose option 2, and enter your details as required. Soon after
81-
submitting your details, you will receive an email which will be used to confirm
82-
your registration.
83-
84-
Once you are registered, you may choose option 1 from the menu. You will be
85-
prompted for your PyPI username and password, and :command:`register` will then
86-
submit your meta-data to the index.
87-
88-
See :ref:`package-cmdoptions` for options to the :command:`register` command.
89-
90-
9148
.. _package-upload:
9249

9350
The ``upload`` command
@@ -107,11 +64,6 @@ PyPI. Note that these will be uploaded even if they are built using an earlier
10764
invocation of :file:`setup.py`, but that only distributions named on the command
10865
line for the invocation including the :command:`upload` command are uploaded.
10966

110-
If a :command:`register` command was previously called in the same command,
111-
and if the password was entered in the prompt, :command:`upload` will reuse the
112-
entered password. This is useful if you do not want to store a password in
113-
clear text in a :file:`.pypirc` file.
114-
11567
You can use the ``--sign`` option to tell :command:`upload` to sign each
11668
uploaded file using GPG (GNU Privacy Guard). The :program:`gpg` program must
11769
be available for execution on the system :envvar:`PATH`. You can also specify
@@ -126,8 +78,7 @@ command.
12678
Additional command options
12779
--------------------------
12880

129-
This section describes options common to both the :command:`register` and
130-
:command:`upload` commands.
81+
This section describes options common to the :command:`upload` command.
13182

13283
The ``--repository`` or ``-r`` option lets you specify a PyPI server
13384
different from the default. For example::
@@ -154,7 +105,7 @@ server, which is useful when debugging problems with registering and uploading.
154105
The ``.pypirc`` file
155106
--------------------
156107

157-
The :command:`register` and :command:`upload` commands both check for the
108+
The :command:`upload` command check for the
158109
existence of a :file:`.pypirc` file at the location :file:`$HOME/.pypirc`.
159110
If this file exists, the command uses the username, password, and repository
160111
URL configured in the file. The format of a :file:`.pypirc` file is as
@@ -198,7 +149,7 @@ listed in the *index-servers* variable::
198149
username: <username>
199150
password: <password>
200151

201-
This allows the :command:`register` and :command:`upload` commands to be
152+
This allows the :command:`upload` command to be
202153
called with the ``--repository`` option as described in
203154
:ref:`package-cmdoptions`.
204155

Doc/distutils/setupscript.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -612,9 +612,8 @@ Notes:
612612
<https://pypi.org>`_.
613613

614614
(5)
615-
The ``long_description`` field is used by PyPI when you are
616-
:ref:`registering <package-register>` a package, to
617-
:ref:`build its home page <package-display>`.
615+
The ``long_description`` field is used by PyPI when you publish a package,
616+
to build its project page.
618617

619618
(6)
620619
The ``license`` field is a text indicating the license covering the

0 commit comments

Comments
 (0)