Skip to content

Commit 33bf5ff

Browse files
authored
Merge branch 'main' into patch-1
2 parents ef609d0 + 9b735c9 commit 33bf5ff

7 files changed

+28
-22
lines changed

source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,10 +141,10 @@
141141
"dh-virtualenv": ("https://dh-virtualenv.readthedocs.io/en/latest/", None),
142142
"distlib": ("https://distlib.readthedocs.io/en/latest/", None),
143143
"flexx": ("https://flexx.readthedocs.io/en/latest/", None),
144+
"flit": ("https://flit.pypa.io/en/stable/", None),
144145
"nox": ("https://nox.thea.codes/en/latest/", None),
145146
"openstack": ("https://docs.openstack.org/glance/latest/", None),
146147
"packaging": ("https://packaging.pypa.io/en/latest/", None),
147-
"packaging.python.org": ("https://packaging.python.org/en/latest/", None),
148148
"pip": ("https://pip.pypa.io/en/latest/", None),
149149
"pipenv": ("https://pipenv.pypa.io/en/latest/", None),
150150
"piwheels": ("https://piwheels.readthedocs.io/en/latest/", None),

source/discussions/setup-py-deprecated.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,17 +100,20 @@ The recommendation is to use a test runner such as pytest_.
100100

101101
A trusted replacement is :ref:`twine`:
102102

103-
* ``python -m twine check``
104-
* ``python -m twine register``
105-
* ``python -m twine upload``
103+
* ``python -m twine check --strict dist/*``
104+
* ``python -m twine register dist/*.whl`` [#not-pypi]_
105+
* ``python -m twine upload dist/*``
106+
107+
.. [#not-pypi] Not necessary, nor supported on :term:`PyPI <Python Package Index (PyPI)>`.
108+
But might be necessary on other :term:`package indexes <package index>` (for example :ref:`devpi`).
106109
107110
108111
``python setup.py --version``
109112
-----------------------------
110113

111114
A possible replacement solution (among others) is to rely on setuptools-scm_:
112115

113-
* ``python -m setuptools-scm``
116+
* ``python -m setuptools_scm``
114117

115118
.. _setuptools-scm: https://setuptools-scm.readthedocs.io/en/latest/usage/#as-cli-tool
116119

source/guides/distributing-packages-using-setuptools.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,8 +233,7 @@ the front-page lists of trending projects and new releases, and the list of
233233
projects you maintain within your account profile (such as
234234
https://pypi.org/user/jaraco/).
235235

236-
A `content type
237-
<https://packaging.python.org/specifications/core-metadata/#description-content-type-optional>`_
236+
A :ref:`content type <core-metadata-description-content-type>`
238237
can be specified with the ``long_description_content_type`` argument, which can
239238
be one of ``text/plain``, ``text/x-rst``, or ``text/markdown``, corresponding
240239
to no formatting, `reStructuredText (reST)

source/guides/installing-stand-alone-command-line-tools.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,4 +128,4 @@ To see the full list of commands pipx offers, run:
128128
129129
pipx --help
130130
131-
You can learn more about pipx at https://pypa.github.io/pipx/.
131+
You can learn more about pipx at https://pipx.pypa.io/.

source/guides/modernize-setup-py-project.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ triggers :ref:`pip` to change its default behavior to use *build isolation*.
6666
For more details:
6767

6868
* :ref:`distributing-packages`
69-
* :ref:`declaring-build-dependencies`
69+
* :ref:`pyproject-build-system-table`
7070
* :doc:`pip:reference/build-system/pyproject-toml`
7171

7272

@@ -110,7 +110,7 @@ requires a :file:`pyproject.toml` file like this (:file:`setup.py` stays unchang
110110
111111
For more details:
112112

113-
* :ref:`declaring-build-dependencies`
113+
* :ref:`pyproject-build-system-table`
114114

115115

116116
What is the build isolation feature?
@@ -161,7 +161,7 @@ can be entirely replaced by a :file:`pyproject.toml` file like this:
161161
version = "1.2.3"
162162
163163
164-
Read :ref:`declaring-project-metadata` for the full specification
164+
Read :ref:`pyproject-project-table` for the full specification
165165
of the content allowed in the ``[project]`` table.
166166

167167

@@ -243,7 +243,6 @@ This file can be as minimalistic as this:
243243
Where to read more about this?
244244
==============================
245245

246-
* :ref:`declaring-build-dependencies`
247-
* :ref:`declaring-project-metadata`
246+
* :ref:`pyproject-toml-spec`
248247
* :doc:`pip:reference/build-system/pyproject-toml`
249248
* :doc:`setuptools:build_meta`

source/key_projects.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ application-centric alternative to :ref:`pip`'s lower-level
233233
pipx
234234
====
235235

236-
`Docs <https://pypa.github.io/pipx/>`__ |
236+
`Docs <https://pipx.pypa.io/>`__ |
237237
`GitHub <https://github.com/pypa/pipx>`__ |
238238
`PyPI <https://pypi.org/project/pipx/>`__
239239

@@ -244,7 +244,7 @@ causing dependency conflicts with other packages installed on the system.
244244
Python Packaging User Guide
245245
===========================
246246

247-
:doc:`Docs <packaging.python.org:index>` |
247+
:doc:`Docs <index>` |
248248
`Issues <https://github.com/pypa/packaging.python.org/issues>`__ |
249249
`GitHub <https://github.com/pypa/packaging.python.org>`__
250250

@@ -292,8 +292,7 @@ trove-classifiers
292292

293293
trove-classifiers is the canonical source for `classifiers on PyPI
294294
<https://pypi.org/classifiers/>`_, which project maintainers use to
295-
`systematically describe their projects
296-
<https://packaging.python.org/specifications/core-metadata/#classifier-multiple-use>`_
295+
:ref:`systematically describe their projects <core-metadata-classifier>`
297296
so that users can better find projects that match their needs on the PyPI.
298297

299298
The trove-classifiers package contains a list of valid classifiers and

source/tutorials/packaging-projects.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -529,14 +529,16 @@ differences:
529529
At this point if you want to read more on packaging Python libraries here are
530530
some things you can do:
531531

532-
.. TODO: Add links to other guides
533-
.. TODO: Add links to backend configuration docs
534-
532+
* Read about advanced configuration for your chosen build backend:
533+
`Hatchling <hatchling-config_>`_,
534+
:doc:`setuptools <setuptools:userguide/pyproject_config>`,
535+
:doc:`Flit <flit:pyproject_toml>`, `PDM <pdm-config_>`_.
536+
* Look at the :doc:`guides </guides/index>` on this site for more advanced
537+
practical information, or the :doc:`discussions </discussions/index>`
538+
for explanations and background on specific topics.
535539
* Consider packaging tools that provide a single command-line interface for
536540
project management and packaging, such as :ref:`hatch`, :ref:`flit`,
537541
:ref:`pdm`, and :ref:`poetry`.
538-
* Read :pep:`517` and :pep:`518` for background and details on build tool configuration.
539-
* Read about :doc:`/guides/packaging-binary-extensions`.
540542

541543

542544
----
@@ -549,3 +551,7 @@ some things you can do:
549551
and considered an **advanced topic** (not covered in this tutorial).
550552
If you are only getting started with Python packaging, it is recommended to
551553
stick with *regular packages* and ``__init__.py`` (even if the file is empty).
554+
555+
556+
.. _hatchling-config: https://hatch.pypa.io/latest/config/metadata/
557+
.. _pdm-config: https://pdm-project.org/latest/reference/pep621/

0 commit comments

Comments
 (0)