From 56e51d4ac98bdb52b227602dc820f9c99eb5586a Mon Sep 17 00:00:00 2001 From: "C.A.M. Gerlach" Date: Tue, 28 Jun 2022 23:13:47 -0500 Subject: [PATCH 1/3] Update headers/etc. of older packaging PEPs to reflect replacement PEPs --- pep-0241.txt | 8 ++++---- pep-0262.txt | 10 +++++++--- pep-0314.txt | 8 ++++---- pep-0345.txt | 15 ++++++++------- pep-0376.txt | 9 ++++----- pep-0566.rst | 7 +++---- 6 files changed, 30 insertions(+), 27 deletions(-) diff --git a/pep-0241.txt b/pep-0241.txt index 41a4c757f4a..e82b2267bac 100644 --- a/pep-0241.txt +++ b/pep-0241.txt @@ -1,14 +1,14 @@ PEP: 241 Title: Metadata for Python Software Packages -Version: $Revision$ -Last-Modified: $Date$ Author: A.M. Kuchling -Status: Final +Discussions-To: distutils-sig@python.org +Status: Superseded Type: Standards Track Topic: Packaging Content-Type: text/x-rst Created: 12-Mar-2001 -Post-History: 19-Mar-2001 +Post-History: `19-Mar-2001 `__ +Superseded-By: 314 Introduction diff --git a/pep-0262.txt b/pep-0262.txt index 116d5e9db39..d8baaf0e892 100644 --- a/pep-0262.txt +++ b/pep-0262.txt @@ -1,15 +1,19 @@ PEP: 262 Title: A Database of Installed Python Packages -Version: $Revision$ -Last-Modified: $Date$ Author: A.M. Kuchling -Status: Deferred +Status: Rejected Type: Standards Track Topic: Packaging Content-Type: text/x-rst Created: 08-Jul-2001 Post-History: 27-Mar-2002 + +.. note:: + This PEP was superseded by :pep:`345` and :pep:`376`, which were accepted. + Therefore, this PEP is (by implication) rejected. + + Introduction ============ diff --git a/pep-0314.txt b/pep-0314.txt index 71a713c5da9..6817cff3e10 100644 --- a/pep-0314.txt +++ b/pep-0314.txt @@ -1,9 +1,8 @@ PEP: 314 -Title: Metadata for Python Software Packages v1.1 -Version: $Revision$ -Last-Modified: $Date$ +Title: Metadata for Python Software Packages 1.1 Author: A.M. Kuchling, Richard Jones -Status: Final +Discussions-To: distutils-sig@python.org +Status: Superseded Type: Standards Track Topic: Packaging Content-Type: text/x-rst @@ -11,6 +10,7 @@ Created: 12-Apr-2003 Python-Version: 2.5 Post-History: 29-Apr-2003 Replaces: 241 +Superseded-By: 345 Introduction diff --git a/pep-0345.txt b/pep-0345.txt index a28fb1aa80b..876f5c0f2f2 100644 --- a/pep-0345.txt +++ b/pep-0345.txt @@ -1,16 +1,17 @@ PEP: 345 Title: Metadata for Python Software Packages 1.2 -Version: $Revision$ -Last-Modified: $Date$ Author: Richard Jones Discussions-To: distutils-sig@python.org -Status: Final +Status: Superseded Type: Standards Track Topic: Packaging Content-Type: text/x-rst Created: 28-Apr-2005 -Python-Version: 2.5 -Post-History: +Python-Version: 2.7 +Post-History: `22-Dec-2009 `__ +Replaces: 314 +Superseded-By: 566 +Resolution: https://mail.python.org/archives/list/python-dev@python.org/thread/MKHXVV746H7ZDFN62Z72VNAX6KIRXNRO/ Abstract @@ -396,8 +397,8 @@ Examples:: Project-URL: Documentation, https://setuptools.readthedocs.io/ Project-URL: Funding, https://donate.pypi.org -The label is free text, with a maximum length of 32 characters. Notice -that distributions uploaded to PyPI will have these extra entries +The label is free text, with a maximum length of 32 characters. Notice +that distributions uploaded to PyPI will have these extra entries displayed under the "Project links" section of their landing page. diff --git a/pep-0376.txt b/pep-0376.txt index 6afb128f827..2286c518433 100644 --- a/pep-0376.txt +++ b/pep-0376.txt @@ -1,7 +1,5 @@ PEP: 376 Title: Database of Installed Python Distributions -Version: $Revision$ -Last-Modified: $Date$ Author: Tarek Ziadé Status: Final Type: Standards Track @@ -9,7 +7,8 @@ Topic: Packaging Content-Type: text/x-rst Created: 22-Feb-2009 Python-Version: 2.7, 3.2 -Post-History: +Post-History: `22-Jun-2009 `__ + Abstract ======== @@ -22,8 +21,8 @@ To achieve this goal, the PEP proposes a new format to describe installed distributions on a system. It also describes a reference implementation for the standard library. -In the past an attempt was made to create an installation database (see :pep:`262` -). +In the past an attempt was made to create an installation database +(see :pep:`262`). Combined with :pep:`345`, the current proposal supersedes :pep:`262`. diff --git a/pep-0566.rst b/pep-0566.rst index f84e040b77d..a0091c59f6a 100644 --- a/pep-0566.rst +++ b/pep-0566.rst @@ -1,7 +1,5 @@ PEP: 566 Title: Metadata for Python Software Packages 2.1 -Version: $Revision$ -Last-Modified: $Date$ Author: Dustin Ingram BDFL-Delegate: Daniel Holth Discussions-To: distutils-sig@python.org @@ -15,12 +13,13 @@ Post-History: Replaces: 345 Resolution: https://mail.python.org/pipermail/distutils-sig/2018-February/032014.html + Abstract ======== This PEP describes the changes between versions 1.2 and 2.1 of the core -metadata specification for Python packages. Version 1.2 is specified in PEP -345. +metadata specification for Python packages. Version 1.2 is specified in +:pep:`345`. It also changes to the canonical source for field specifications to the `Core Metadata Specification`_ reference document, which includes specifics of the From 974852543c6314afbeab6dfa00d7ada3ffdb6ecf Mon Sep 17 00:00:00 2001 From: "C.A.M. Gerlach" Date: Wed, 10 Aug 2022 00:36:09 -0500 Subject: [PATCH 2/3] Infra: Fix lowercase and tweak plural in text for PyPA spec banner --- .../pep_processor/parsing/pep_banner_directive.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pep_sphinx_extensions/pep_processor/parsing/pep_banner_directive.py b/pep_sphinx_extensions/pep_processor/parsing/pep_banner_directive.py index 4a42186be02..11345e11871 100644 --- a/pep_sphinx_extensions/pep_processor/parsing/pep_banner_directive.py +++ b/pep_sphinx_extensions/pep_processor/parsing/pep_banner_directive.py @@ -84,12 +84,12 @@ class CanonicalPyPASpecBanner(PEPBanner): admonition_pre_template = ( "This PEP is a historical document. " - "the up-to-date, canonical spec, {link_content}, is maintained on " + "The up-to-date, canonical spec, {link_content}, is maintained on " f"the `PyPA specs page <{PYPA_SPEC_BASE_URL}>`__." ) admonition_pre_text = ( "This PEP is a historical document. " - "The up-to-date, canonical specification is maintained on " + "The up-to-date, canonical specifications are maintained on " f"the `PyPA specs page <{PYPA_SPEC_BASE_URL}>`__." ) admonition_post_text = ( From e232ca1ce48afc9eb61ee67c69059e0437000325 Mon Sep 17 00:00:00 2001 From: "C.A.M. Gerlach" Date: Wed, 10 Aug 2022 00:27:56 -0500 Subject: [PATCH 3/3] Add banner to all relevant PEPs pointing to their canonical PyPA specs --- pep-0376.txt | 3 +++ pep-0425.txt | 3 +++ pep-0427.txt | 7 ++----- pep-0566.rst | 3 +++ pep-0610.rst | 13 ++++--------- pep-0621.rst | 6 ++---- pep-0627.rst | 3 +++ pep-0643.rst | 3 +++ pep-0685.rst | 3 +++ 9 files changed, 26 insertions(+), 18 deletions(-) diff --git a/pep-0376.txt b/pep-0376.txt index 2286c518433..5cc2bfc8f3c 100644 --- a/pep-0376.txt +++ b/pep-0376.txt @@ -10,6 +10,9 @@ Python-Version: 2.7, 3.2 Post-History: `22-Jun-2009 `__ +.. canonical-pypa-spec:: :ref:`packaging:core-metadata` + + Abstract ======== diff --git a/pep-0425.txt b/pep-0425.txt index 43d420a06ca..46c0287f9eb 100644 --- a/pep-0425.txt +++ b/pep-0425.txt @@ -14,6 +14,9 @@ Post-History: 08-Aug-2012, 18-Oct-2012, 15-Feb-2013 Resolution: https://mail.python.org/pipermail/python-dev/2013-February/124116.html +.. canonical-pypa-spec:: :ref:`packaging:platform-compatibility-tags` + + Abstract ======== diff --git a/pep-0427.txt b/pep-0427.txt index 423fc11d4b7..d75ac752a69 100644 --- a/pep-0427.txt +++ b/pep-0427.txt @@ -13,12 +13,9 @@ Created: 20-Sep-2012 Post-History: 18-Oct-2012, 15-Feb-2013 Resolution: https://mail.python.org/pipermail/python-dev/2013-February/124103.html -Canonical specification -======================= -The canonical version of the wheel format specification is now maintained at -https://packaging.python.org/specifications/binary-distribution-format/ . -This may contain amendments relative to this PEP. +.. canonical-pypa-spec:: :ref:`packaging:binary-distribution-format` + Abstract ======== diff --git a/pep-0566.rst b/pep-0566.rst index a0091c59f6a..5b81c63c7f0 100644 --- a/pep-0566.rst +++ b/pep-0566.rst @@ -14,6 +14,9 @@ Replaces: 345 Resolution: https://mail.python.org/pipermail/distutils-sig/2018-February/032014.html +.. canonical-pypa-spec:: :ref:`packaging:core-metadata` + + Abstract ======== diff --git a/pep-0610.rst b/pep-0610.rst index 27b0cf2ada7..5e20ea55c69 100644 --- a/pep-0610.rst +++ b/pep-0610.rst @@ -12,6 +12,10 @@ Created: 21-Apr-2019 Post-History: Resolution: https://discuss.python.org/t/1535/56 + +.. canonical-pypa-spec:: :ref:`packaging:direct-url` + + Abstract ======== @@ -26,15 +30,6 @@ additional metadata, to be added to the installed distribution by the installation front end, which records the Direct URL Origin for use by consumers which introspect the database of installed packages (see :pep:`376`). -Provisional acceptance -====================== - -In accordance with the PyPA's specification process, this PEP has been -`provisionally accepted `_ -for initial implementation in ``pip`` and other PyPA tools. - -During this time, the specification is still subject to revision based -on real world experience with those initial implementations. Motivation ========== diff --git a/pep-0621.rst b/pep-0621.rst index 90a407ae3ca..c4c2a23f8fc 100644 --- a/pep-0621.rst +++ b/pep-0621.rst @@ -19,10 +19,8 @@ Post-History: 22-Jun-2020, 31-Oct-2020 Resolution: https://discuss.python.org/t/pep-621-round-3/5472/109 -.. note:: - The official specification for the ``[project]`` table in - ``pyproject.toml`` now lives at - https://packaging.python.org/en/latest/specifications/declaring-project-metadata/ . + +.. canonical-pypa-spec:: :ref:`packaging:declaring-project-metadata` Abstract diff --git a/pep-0627.rst b/pep-0627.rst index da434054fd1..81a13d72df5 100644 --- a/pep-0627.rst +++ b/pep-0627.rst @@ -11,6 +11,9 @@ Created: 15-Jul-2020 Resolution: https://discuss.python.org/t/pep-627/4126/42 +.. canonical-pypa-spec:: :ref:`packaging:recording-installed-packages` + + Abstract ======== diff --git a/pep-0643.rst b/pep-0643.rst index 15d9d07b0e5..08fc1f67551 100644 --- a/pep-0643.rst +++ b/pep-0643.rst @@ -12,6 +12,9 @@ Post-History: 24-Oct-2020, 01-Nov-2020, 02-Nov-2020, 14-Nov-2020 Resolution: https://discuss.python.org/t/pep-643-metadata-for-package-source-distributions/5577/53 +.. canonical-pypa-spec:: :ref:`packaging:core-metadata` + + Abstract ======== diff --git a/pep-0685.rst b/pep-0685.rst index 373f9a9961c..04d1f910a46 100644 --- a/pep-0685.rst +++ b/pep-0685.rst @@ -12,6 +12,9 @@ Post-History: `08-Mar-2022 `__ Resolution: https://discuss.python.org/t/pep-685-comparison-of-extra-names-for-optional-distribution-dependencies/14141/55 +.. canonical-pypa-spec:: + + Abstract ========