@@ -57,13 +57,13 @@ When you're done, the project structure will look like this:
5757 Creating a test directory
5858-------------------------
5959
60- :file: `tests/ ` is a placeholder for unit test files. Leave it empty for now.
60+ :file: `tests/ ` is a placeholder for test files. Leave it empty for now.
6161
6262
6363Creating pyproject.toml
6464-----------------------
6565
66- :file: `pyproject.toml ` is the file that tells build tools (like ``pip `` 10+ and
66+ :file: `pyproject.toml ` is the file that tells build tools (like ``pip `` and
6767``build ``) what system you are using and what is required for building. The
6868default if this file is missing is to assume a classic setuptools build system,
6969but it is better to be explicit; if you have a :file: `pyproject.toml ` file, you
@@ -155,20 +155,20 @@ an escape hatch when absolutely necessary.
155155 This example package uses a relatively minimal set of metadata:
156156
157157 - ``name `` is the *distribution name * of your package. This can be any name as
158- long as only contains letters, numbers, ``_ `` , and ``- ``. It also must not
158+ long as it only contains letters, numbers, ``_ `` , and ``- ``. It also must not
159159 already be taken on pypi.org. **Be sure to update this with your username, **
160160 as this ensures you won't try to upload a package with the same name as one
161- which already exists when you upload the package .
161+ which already exists.
162162 - ``version `` is the package version. See :pep: `440 ` for more details on
163163 versions. You can use ``file: `` or ``attr: `` directives to read from a file or
164- package attribute (simple attributes do not require import) .
164+ package attribute.
165165 - ``author `` and ``author_email `` are used to identify the author of the
166166 package.
167167 - ``description `` is a short, one-sentence summary of the package.
168168 - ``long_description `` is a detailed description of the package. This is
169169 shown on the package detail page on the Python Package Index. In
170- this case, the long description is loaded from :file: `README.md ` which is
171- a common pattern, using the ``file: `` directive.
170+ this case, the long description is loaded from :file: `README.md ` ( which is
171+ a common pattern) using the ``file: `` directive.
172172 - ``long_description_content_type `` tells the index what type of markup is
173173 used for the long description. In this case, it's Markdown.
174174 - ``url `` is the URL for the homepage of the project. For many projects, this
@@ -271,18 +271,18 @@ an escape hatch when absolutely necessary.
271271 minimal set:
272272
273273 - ``name `` is the *distribution name * of your package. This can be any name as
274- long as only contains letters, numbers, ``_ `` , and ``- ``. It also must not
274+ long as it only contains letters, numbers, ``_ `` , and ``- ``. It also must not
275275 already be taken on pypi.org. **Be sure to update this with your username, **
276276 as this ensures you won't try to upload a package with the same name as one
277- which already exists when you upload the package .
278- - ``version `` is the package version see :pep: `440 ` for more details on
277+ which already exists.
278+ - ``version `` is the package version. See :pep: `440 ` for more details on
279279 versions.
280280 - ``author `` and ``author_email `` are used to identify the author of the
281281 package.
282282 - ``description `` is a short, one-sentence summary of the package.
283283 - ``long_description `` is a detailed description of the package. This is
284284 shown on the package detail page on the Python Package Index. In
285- this case, the long description is loaded from :file: `README.md ` which is
285+ this case, the long description is loaded from :file: `README.md `, which is
286286 a common pattern.
287287 - ``long_description_content_type `` tells the index what type of markup is
288288 used for the long description. In this case, it's Markdown.
@@ -378,21 +378,20 @@ The files listed above will be included automatically in your
378378:term: `source distribution <Source Distribution (or "sdist")> `. If you want to control what goes in this
379379explicitly, see :ref: `Using MANIFEST.in `.
380380
381- The final :term: `built distribution <Built Distribution> ` will
382- have the Python files in the
383- discovered or listed Python packages. If you want to control what goes here,
384- such as to add data files, see :std:doc: `Including Data Files
385- <setuptools:userguide/datafiles>` from the :std:doc: `setuptools docs
386- <setuptools:index>`.
381+ The final :term: `built distribution <Built Distribution> ` will have the Python
382+ files in the discovered or listed Python packages. If you want to control what
383+ goes here, such as to add data files, see
384+ :std:doc: `Including Data Files <setuptools:userguide/datafiles >`
385+ from the :std:doc: `setuptools docs <setuptools:index >`.
387386
388387.. _generating archives :
389388
390389Generating distribution archives
391390--------------------------------
392391
393392The next step is to generate :term: `distribution packages <Distribution
394- Package> ` for the package. These are archives that are uploaded to the Package
395- Index and can be installed by :ref: `pip `.
393+ Package> ` for the package. These are archives that are uploaded to the Python
394+ Package Index and can be installed by :ref: `pip `.
396395
397396Make sure you have the latest versions of PyPA's ``build `` installed:
398397
@@ -453,8 +452,8 @@ Uploading the distribution archives
453452
454453Finally, it's time to upload your package to the Python Package Index!
455454
456- The first thing you'll need to do is register an account on `` Test PyPI ``. Test
457- PyPI is a separate instance of the package index intended for testing and
455+ The first thing you'll need to do is register an account on Test PyPI, which
456+ is a separate instance of the package index intended for testing and
458457experimentation. It's great for things like this tutorial where we don't
459458necessarily want to upload to the real index. To register an account, go to
460459https://test.pypi.org/account/register/ and complete the steps on that page.
0 commit comments