Skip to content

Commit 5e14a51

Browse files
authored
Merge pull request #1391 from jeanas/tutorial-link-pyproject-guide
Link to pyproject.toml guide in "Packaging Python projects" tutorial
2 parents 1142846 + 77c643c commit 5e14a51

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

source/guides/writing-pyproject-toml.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ field. For example: ``requires-python = ">= 3.8"``, or ``version =
9999

100100
However, in some cases, it is useful to let your build backend compute
101101
the metadata for you. For example: many build backends can read the
102-
version from a ``__version__`` attribute in your code, or similar.
103-
In such cases, you should mark the field as dynamic using, e.g.,
102+
version from a ``__version__`` attribute in your code, a Git tag, or
103+
similar. In such cases, you should mark the field as dynamic using, e.g.,
104104

105105
.. code-block:: toml
106106

source/tutorials/packaging-projects.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -216,17 +216,16 @@ following this tutorial.
216216
]
217217
218218
[project.urls]
219-
"Homepage" = "https://github.com/pypa/sampleproject"
220-
"Bug Tracker" = "https://github.com/pypa/sampleproject/issues"
219+
Homepage = "https://github.com/pypa/sampleproject"
220+
Issues = "https://github.com/pypa/sampleproject/issues"
221221
222222
- ``name`` is the *distribution name* of your package. This can be any name as
223223
long as it only contains letters, numbers, ``.``, ``_`` , and ``-``. It also
224224
must not already be taken on PyPI. **Be sure to update this with your
225225
username** for this tutorial, as this ensures you won't try to upload a
226226
package with the same name as one which already exists.
227-
- ``version`` is the package version. See the :ref:`version specifier specification <version-specifiers>`
228-
for more details on versions. Some build backends allow it to be specified
229-
another way, such as from a file or a git tag.
227+
- ``version`` is the package version. (Some build backends allow it to be
228+
specified another way, such as from a file or Git tag.)
230229
- ``authors`` is used to identify the author of the package; you specify a name
231230
and an email for each author. You can also list ``maintainers`` in the same
232231
format.
@@ -235,9 +234,9 @@ following this tutorial.
235234
package. This is shown on the package detail page on PyPI.
236235
In this case, the description is loaded from :file:`README.md` (which is a
237236
common pattern). There also is a more advanced table form described in the
238-
:ref:`project metadata specification <declaring-project-metadata>`.
237+
:ref:`pyproject.toml guide <writing-pyproject-toml>`.
239238
- ``requires-python`` gives the versions of Python supported by your
240-
project. Installers like :ref:`pip` will look back through older versions of
239+
project. An installer like :ref:`pip` will look back through older versions of
241240
packages until it finds one that has a matching Python version.
242241
- ``classifiers`` gives the index and :ref:`pip` some additional metadata
243242
about your package. In this case, the package is only compatible with Python
@@ -249,10 +248,11 @@ following this tutorial.
249248
- ``urls`` lets you list any number of extra links to show on PyPI.
250249
Generally this could be to the source, documentation, issue trackers, etc.
251250

252-
See the :ref:`project metadata specification <declaring-project-metadata>` for
253-
details on these and other fields that can be defined in the ``[project]``
254-
table. Other common fields are ``keywords`` to improve discoverability and the
255-
``dependencies`` that are required to install your package.
251+
See the :ref:`pyproject.toml guide <writing-pyproject-toml>` for details
252+
on these and other fields that can be defined in the ``[project]``
253+
table. Other common fields are ``keywords`` to improve discoverability
254+
and the ``dependencies`` that are required to install your package.
255+
256256

257257
Creating README.md
258258
------------------

0 commit comments

Comments
 (0)