Packaging PEPs: Update headers & link canonical PyPA specs (#2690)

* Update headers/etc. of older packaging PEPs to reflect replacement PEPs

* Infra: Fix lowercase and tweak plural in text for PyPA spec banner

* Add banner to all relevant PEPs pointing to their canonical PyPA specs

Co-authored-by: Brett Cannon <brett@python.org>
This commit is contained in:
C.A.M. Gerlach 2022-10-07 08:29:13 -07:00 committed by GitHub
parent e46b83661d
commit bf3465d3e3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 58 additions and 47 deletions

View File

@ -1,14 +1,14 @@
PEP: 241
Title: Metadata for Python Software Packages
Version: $Revision$
Last-Modified: $Date$
Author: A.M. Kuchling <amk@amk.ca>
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 <https://mail.python.org/archives/list/distutils-sig@python.org/thread/46XPDHQHI3XAAJHEZAMAMKZYAI6K7NB6/>`__
Superseded-By: 314
Introduction

View File

@ -1,15 +1,19 @@
PEP: 262
Title: A Database of Installed Python Packages
Version: $Revision$
Last-Modified: $Date$
Author: A.M. Kuchling <amk@amk.ca>
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
============

View File

@ -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

View File

@ -1,16 +1,17 @@
PEP: 345
Title: Metadata for Python Software Packages 1.2
Version: $Revision$
Last-Modified: $Date$
Author: Richard Jones <richard@python.org>
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 <https://mail.python.org/archives/list/python-dev@python.org/thread/5QWS2FXKZNNPKNZO6RLPGT5NORS5ZQ2V/>`__
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.

View File

@ -1,7 +1,5 @@
PEP: 376
Title: Database of Installed Python Distributions
Version: $Revision$
Last-Modified: $Date$
Author: Tarek Ziadé <tarek@ziade.org>
Status: Final
Type: Standards Track
@ -9,7 +7,11 @@ Topic: Packaging
Content-Type: text/x-rst
Created: 22-Feb-2009
Python-Version: 2.7, 3.2
Post-History:
Post-History: `22-Jun-2009 <https://mail.python.org/archives/list/python-dev@python.org/thread/ILLTIOZAULMDY5CAS6GOITEYJ4HNFATQ/#ILLTIOZAULMDY5CAS6GOITEYJ4HNFATQ>`__
.. canonical-pypa-spec:: :ref:`packaging:core-metadata`
Abstract
========
@ -22,8 +24,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`.

View File

@ -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
========

View File

@ -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
========

View File

@ -1,7 +1,5 @@
PEP: 566
Title: Metadata for Python Software Packages 2.1
Version: $Revision$
Last-Modified: $Date$
Author: Dustin Ingram <di@python.org>
BDFL-Delegate: Daniel Holth
Discussions-To: distutils-sig@python.org
@ -15,12 +13,16 @@ Post-History:
Replaces: 345
Resolution: https://mail.python.org/pipermail/distutils-sig/2018-February/032014.html
.. canonical-pypa-spec:: :ref:`packaging:core-metadata`
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

View File

@ -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 <https://www.pypa.io/en/latest/specifications/#provisional-acceptance>`_
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
==========

View File

@ -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

View File

@ -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
========

View File

@ -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
========

View File

@ -12,6 +12,9 @@ Post-History: `08-Mar-2022 <https://discuss.python.org/t/14141>`__
Resolution: https://discuss.python.org/t/pep-685-comparison-of-extra-names-for-optional-distribution-dependencies/14141/55
.. canonical-pypa-spec::
Abstract
========

View File

@ -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 = (