Skip to content

Commit 216459a

Browse files
authored
Merge branch 'main' into 866-lowercase-terms
2 parents 7153008 + 61480be commit 216459a

1 file changed

Lines changed: 20 additions & 21 deletions

File tree

source/tutorials/packaging-projects.rst

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@ project's root directory - you will add content to them in the following steps.
5959
Creating a test folder
6060
----------------------
6161

62-
:file:`tests/` is a placeholder for unit test files. Leave it empty for now.
62+
:file:`tests/` is a placeholder for test files. Leave it empty for now.
6363

6464

6565
Creating pyproject.toml
6666
-----------------------
6767

68-
:file:`pyproject.toml` is the file that tells build tools (like ``pip`` 10+ and
68+
:file:`pyproject.toml` is the file that tells build tools (like ``pip`` and
6969
``build``) what system you are using and what is required for building. The
7070
default if this file is missing is to assume a classic setuptools build system,
7171
but it is better to be explicit; if you have a :file:`pyproject.toml` file, you
@@ -157,20 +157,20 @@ an escape hatch when absolutely necessary.
157157
This example package uses a relatively minimal set of metadata:
158158

159159
- ``name`` is the *distribution name* of your package. This can be any name as
160-
long as only contains letters, numbers, ``_`` , and ``-``. It also must not
160+
long as it only contains letters, numbers, ``_`` , and ``-``. It also must not
161161
already be taken on pypi.org. **Be sure to update this with your username,**
162162
as this ensures you won't try to upload a package with the same name as one
163-
which already exists when you upload the package.
163+
which already exists.
164164
- ``version`` is the package version. See :pep:`440` for more details on
165165
versions. You can use ``file:`` or ``attr:`` directives to read from a file or
166-
package attribute (simple attributes do not require import).
166+
package attribute.
167167
- ``author`` and ``author_email`` are used to identify the author of the
168168
package.
169169
- ``description`` is a short, one-sentence summary of the package.
170170
- ``long_description`` is a detailed description of the package. This is
171171
shown on the package detail page on the Python Package Index. In
172-
this case, the long description is loaded from :file:`README.md` which is
173-
a common pattern, using the ``file:`` directive.
172+
this case, the long description is loaded from :file:`README.md` (which is
173+
a common pattern) using the ``file:`` directive.
174174
- ``long_description_content_type`` tells the index what type of markup is
175175
used for the long description. In this case, it's Markdown.
176176
- ``url`` is the URL for the homepage of the project. For many projects, this
@@ -273,18 +273,18 @@ an escape hatch when absolutely necessary.
273273
minimal set:
274274

275275
- ``name`` is the *distribution name* of your package. This can be any name as
276-
long as only contains letters, numbers, ``_`` , and ``-``. It also must not
276+
long as it only contains letters, numbers, ``_`` , and ``-``. It also must not
277277
already be taken on pypi.org. **Be sure to update this with your username,**
278278
as this ensures you won't try to upload a package with the same name as one
279-
which already exists when you upload the package.
280-
- ``version`` is the package version see :pep:`440` for more details on
279+
which already exists.
280+
- ``version`` is the package version. See :pep:`440` for more details on
281281
versions.
282282
- ``author`` and ``author_email`` are used to identify the author of the
283283
package.
284284
- ``description`` is a short, one-sentence summary of the package.
285285
- ``long_description`` is a detailed description of the package. This is
286286
shown on the package detail page on the Python Package Index. In
287-
this case, the long description is loaded from :file:`README.md` which is
287+
this case, the long description is loaded from :file:`README.md`, which is
288288
a common pattern.
289289
- ``long_description_content_type`` tells the index what type of markup is
290290
used for the long description. In this case, it's Markdown.
@@ -380,21 +380,20 @@ The files listed above will be included automatically in your
380380
:term:`source distribution <Source Distribution (or "sdist")>`. If you want to control what goes in this
381381
explicitly, see :ref:`Using MANIFEST.in`.
382382

383-
The final :term:`built distribution <Built Distribution>` will
384-
have the Python files in the
385-
discovered or listed Python packages. If you want to control what goes here,
386-
such as to add data files, see :std:doc:`Including Data Files
387-
<setuptools:userguide/datafiles>` from the :std:doc:`setuptools docs
388-
<setuptools:index>`.
383+
The final :term:`built distribution <Built Distribution>` will have the Python
384+
files in the discovered or listed Python packages. If you want to control what
385+
goes here, such as to add data files, see
386+
:std:doc:`Including Data Files <setuptools:userguide/datafiles>`
387+
from the :std:doc:`setuptools docs <setuptools:index>`.
389388

390389
.. _generating archives:
391390

392391
Generating distribution archives
393392
--------------------------------
394393

395394
The next step is to generate :term:`distribution packages <Distribution
396-
Package>` for the package. These are archives that are uploaded to the Package
397-
Index and can be installed by :ref:`pip`.
395+
Package>` for the package. These are archives that are uploaded to the Python
396+
Package Index and can be installed by :ref:`pip`.
398397

399398
Make sure you have the latest versions of PyPA's ``build`` installed:
400399

@@ -456,8 +455,8 @@ Uploading the distribution archives
456455

457456
Finally, it's time to upload your package to the Python Package Index!
458457

459-
The first thing you'll need to do is register an account on ``Test PyPI``. Test
460-
PyPI is a separate instance of the package index intended for testing and
458+
The first thing you'll need to do is register an account on Test PyPI, which
459+
is a separate instance of the package index intended for testing and
461460
experimentation. It's great for things like this tutorial where we don't
462461
necessarily want to upload to the real index. To register an account, go to
463462
https://test.pypi.org/account/register/ and complete the steps on that page.

0 commit comments

Comments
 (0)