[Python-checkins] peps: Reorder metadata field descriptions in PEP 426
nick.coghlan
python-checkins at python.org
Sun Feb 3 12:21:23 CET 2013
http://hg.python.org/peps/rev/49bff47a60bc
changeset: 4711:49bff47a60bc
user: Nick Coghlan <ncoghlan at gmail.com>
date: Sun Feb 03 21:21:13 2013 +1000
summary:
Reorder metadata field descriptions in PEP 426
This tries to create a slightly easier to read ordering for the
field descriptions. Roughly:
- basic metadata
- URLs
- contacts
- licensing & classifiers
- what the distribution provides
- what the distribution needs
- extended metadata
files:
pep-0426.txt | 218 +++++++++++++++++++-------------------
1 files changed, 109 insertions(+), 109 deletions(-)
diff --git a/pep-0426.txt b/pep-0426.txt
--- a/pep-0426.txt
+++ b/pep-0426.txt
@@ -117,35 +117,6 @@
Summary: A module for collecting votes from beagles.
-Platform (multiple use)
------------------------
-
-A Platform specification describing an operating system supported by
-the distribution which is not listed in the "Operating System" Trove classifiers.
-See `Classifier`__ below.
-
-__ `Classifier (multiple use)`_
-
-Examples::
-
- Platform: ObscureUnix
- Platform: RareDOS
-
-
-Supported-Platform (multiple use)
----------------------------------
-
-Binary distributions containing a metadata file will use the
-Supported-Platform field in their metadata to specify the OS and
-CPU for which the binary distribution was compiled. The semantics of
-the Supported-Platform field are not specified in this PEP.
-
-Example::
-
- Supported-Platform: RedHat 7.2
- Supported-Platform: i386-win32-2791
-
-
Description (optional, deprecated)
----------------------------------
@@ -197,6 +168,19 @@
".../BeagleVote-latest.tgz", but instead must be ".../BeagleVote-0.45.tgz".)
+Project-URL (multiple use)
+--------------------------
+
+A string containing a label and a browsable URL for the project, separated
+by the last occurrence of comma and space ", ".
+
+The label consists of any permitted header text, including commas.
+
+Example::
+
+ Bug, Issue Tracker, http://bitbucket.org/tarek/distribute/issues/
+
+
Author (optional)
-----------------
@@ -285,61 +269,6 @@
Classifier: Environment :: Console (Text Based)
-Requires-Dist (multiple use)
-----------------------------
-
-Each entry contains a string naming some other distutils
-project required by this distribution.
-
-The format of a requirement string is identical to that of a distribution
-name (e.g., as found in the ``Name:`` field) optionally followed by a
-version declaration within parentheses.
-
-The distribution names should correspond to names as found on the `Python
-Package Index`_; often the same as, but distinct from, the module names
-as accessed with ``import x``.
-
-Version declarations must follow the rules described in
-`Version Specifiers`_
-
-Distributions may also depend on optional features of other distributions.
-See `Optional Features`_ for details.
-
-Examples::
-
- Requires-Dist: pkginfo
- Requires-Dist: PasteDeploy
- Requires-Dist: zope.interface (>3.5.0)
-
-Dependencies mentioned in ``Requires-Dist`` may be installed exclusively
-at run time and are not guaranteed to be available when creating or
-installing a package. If a dependency is needed during distribution
-creation or installation *and* at run time, it should be listed under
-both ``Requires-Dist`` and ``Setup-Requires-Dist``.
-
-
-Setup-Requires-Dist (multiple use)
-----------------------------------
-
-Like ``Requires-Dist``, but names dependencies needed in order to build,
-package or install the distribution. Commonly used to bring in extra
-compiler support or a package needed to generate a manifest from
-version control.
-
-Distributions may also depend on optional features of other distributions.
-See `Optional Features`_ for details.
-
-Examples::
-
- Setup-Requires-Dist: custom_setup_command
-
-Dependencies mentioned in ``Setup-Requires-Dist`` may be installed exclusively
-for setup and are not guaranteed to be available at run time. If a
-dependency is needed during distribution creation or installation
-*and* at run time, it should be listed under both ``Requires-Dist`` and
-``Setup-Requires-Dist``.
-
-
Provides-Dist (multiple use)
----------------------------
@@ -382,6 +311,25 @@
Provides-Dist: virtual_package
+Provides-Extra (multiple use)
+-----------------------------
+
+A string containing the name of an optional feature. Must be printable
+ASCII, not containing whitespace, comma (,), or square brackets [].
+May be used to make a dependency conditional on whether the optional
+feature has been requested.
+
+See `Optional Features`_ for details on the use of this field.
+
+Example::
+
+ Name: beaglevote
+ Provides-Extra: pdf
+ Requires-Dist: reportlab; extra == 'pdf'
+ Requires-Dist: nose; extra == 'test'
+ Requires-Dist: sphinx; extra == 'doc'
+
+
Obsoleted-By (optional)
-----------------------
@@ -403,6 +351,61 @@
Obsoleted-By: MergedProject (>=4.0.0)
+Requires-Dist (multiple use)
+----------------------------
+
+Each entry contains a string naming some other distutils
+project required by this distribution.
+
+The format of a requirement string is identical to that of a distribution
+name (e.g., as found in the ``Name:`` field) optionally followed by a
+version declaration within parentheses.
+
+The distribution names should correspond to names as found on the `Python
+Package Index`_; often the same as, but distinct from, the module names
+as accessed with ``import x``.
+
+Version declarations must follow the rules described in
+`Version Specifiers`_
+
+Distributions may also depend on optional features of other distributions.
+See `Optional Features`_ for details.
+
+Examples::
+
+ Requires-Dist: pkginfo
+ Requires-Dist: PasteDeploy
+ Requires-Dist: zope.interface (>3.5.0)
+
+Dependencies mentioned in ``Requires-Dist`` may be installed exclusively
+at run time and are not guaranteed to be available when creating or
+installing a package. If a dependency is needed during distribution
+creation or installation *and* at run time, it should be listed under
+both ``Requires-Dist`` and ``Setup-Requires-Dist``.
+
+
+Setup-Requires-Dist (multiple use)
+----------------------------------
+
+Like ``Requires-Dist``, but names dependencies needed in order to build,
+package or install the distribution. Commonly used to bring in extra
+compiler support or a package needed to generate a manifest from
+version control.
+
+Distributions may also depend on optional features of other distributions.
+See `Optional Features`_ for details.
+
+Examples::
+
+ Setup-Requires-Dist: custom_setup_command
+
+Dependencies mentioned in ``Setup-Requires-Dist`` may be installed exclusively
+for setup and are not guaranteed to be available at run time. If a
+dependency is needed during distribution creation or installation
+*and* at run time, it should be listed under both ``Requires-Dist`` and
+``Setup-Requires-Dist``.
+
+
Requires-Python (multiple use)
------------------------------
@@ -448,36 +451,33 @@
Requires-External: libpng (>=1.5)
-Project-URL (multiple use)
---------------------------
+Platform (multiple use)
+-----------------------
-A string containing a label and a browsable URL for the project, separated
-by the last occurrence of comma and space ", ".
+A Platform specification describing an operating system supported by
+the distribution which is not listed in the "Operating System" Trove
+classifiers. See `Classifier`__ above.
-The label consists of any permitted header text, including commas.
+__ `Classifier (multiple use)`_
+
+Examples::
+
+ Platform: ObscureUnix
+ Platform: RareDOS
+
+
+Supported-Platform (multiple use)
+---------------------------------
+
+Binary distributions containing a metadata file will use the
+Supported-Platform field in their metadata to specify the OS and
+CPU for which the binary distribution was compiled. The semantics of
+the Supported-Platform field are not specified in this PEP.
Example::
- Bug, Issue Tracker, http://bitbucket.org/tarek/distribute/issues/
-
-
-Provides-Extra (multiple use)
------------------------------
-
-A string containing the name of an optional feature. Must be printable
-ASCII, not containing whitespace, comma (,), or square brackets [].
-May be used to make a dependency conditional on whether the optional
-feature has been requested.
-
-See `Optional Features`_ for details on the use of this field.
-
-Example::
-
- Name: beaglevote
- Provides-Extra: pdf
- Requires-Dist: reportlab; extra == 'pdf'
- Requires-Dist: nose; extra == 'test'
- Requires-Dist: sphinx; extra == 'doc'
+ Supported-Platform: RedHat 7.2
+ Supported-Platform: i386-win32-2791
Extension (multiple use)
--
Repository URL: http://hg.python.org/peps
More information about the Python-checkins
mailing list