various fixes/changes from python-dev feedback
This commit is contained in:
Tarek Ziadé
parent
4b56e99063
commit
bf51d1c019
117
pep-0345.txt
117
pep-0345.txt
|
|
@ -27,10 +27,11 @@ Version 1.1 is specified in PEP 314.
|
|||
Version 1.2 of the metadata format adds a number of optional fields
|
||||
designed to make third-party packaging of Python Software easier.
|
||||
These fields are "Requires-Python", "Requires-External", "Requires-Dist",
|
||||
"Provides-Dist", and "Obsoletes-Dist". This version also updates the
|
||||
"Metadata-Version" field, and adds new fields, "Maintainer",
|
||||
"Maintainer-email" and "Project-URL". This new version also adds
|
||||
`environment markers`.
|
||||
"Provides-Dist", and "Obsoletes-Dist". This version also changes the
|
||||
"Platform" field. Three new fields were also added: "Maintainer",
|
||||
"Maintainer-email" and "Project-URL".
|
||||
|
||||
Last, this new version also adds `environment markers`.
|
||||
|
||||
Fields
|
||||
======
|
||||
|
|
@ -47,8 +48,7 @@ fields must be present.
|
|||
Metadata-Version
|
||||
::::::::::::::::
|
||||
|
||||
Version of the file format; "1.0", "1.1" and "1.2" are the
|
||||
only legal values here.
|
||||
Version of the file format; "1.2" is the only legal value.
|
||||
|
||||
Example::
|
||||
|
||||
|
|
@ -79,14 +79,14 @@ Example::
|
|||
Platform (multiple use)
|
||||
:::::::::::::::::::::::
|
||||
|
||||
A comma-separated list of platform specifications, summarizing
|
||||
the operating systems supported by the package which are not
|
||||
listed in the "Operating System" Trove classifiers. See
|
||||
"Classifier" below.
|
||||
A Platform specification describing an operating system supported by
|
||||
the package which is not listed in the "Operating System" Trove classifiers.
|
||||
See "Classifier" below.
|
||||
|
||||
Example::
|
||||
Examples::
|
||||
|
||||
Platform: ObscureUnix, RareDOS
|
||||
Platform: ObscureUnix
|
||||
Platform: RareDOS
|
||||
|
||||
|
||||
Supported-Platform (multiple use)
|
||||
|
|
@ -257,86 +257,6 @@ Examples::
|
|||
Classifier: Environment :: Console (Text Based)
|
||||
|
||||
|
||||
Requires (multiple use) (deprecated)
|
||||
::::::::::::::::::::::::::::::::::::
|
||||
|
||||
**This field is now deprecated in favor of "Requires-Dist"**
|
||||
|
||||
Each entry contains a string describing some other module or
|
||||
package required by this package.
|
||||
|
||||
The format of a requirement string is identical to that of a
|
||||
module or package name usable with the ``import`` statement,
|
||||
optionally followed by a version declaration within parentheses.
|
||||
|
||||
A version declaration is a series of conditional operators and
|
||||
version numbers, separated by commas. Conditional operators
|
||||
must be one of "<", ">", "<=", ">=", "==", and "!=". Version
|
||||
numbers must be in the format accepted by the
|
||||
distutils.version.StrictVersion class: two or three
|
||||
dot-separated numeric components, with an optional "pre-release"
|
||||
tag on the end consisting of the letter 'a' or 'b' followed by a
|
||||
number. Example version numbers are "1.0", "2.3a2", "1.3.99",
|
||||
|
||||
Any number of conditional operators can be specified, e.g.
|
||||
the string ">1.0, !=1.3.4, <2.0" is a legal version declaration.
|
||||
|
||||
All of the following are possible requirement strings: "rfc822",
|
||||
"zlib (>=1.1.4)", "zope".
|
||||
|
||||
There's no canonical list of what strings should be used; the
|
||||
Python community is left to choose its own standards.
|
||||
|
||||
Examples::
|
||||
|
||||
Requires: re
|
||||
Requires: sys
|
||||
Requires: zlib
|
||||
Requires: xml.parsers.expat (>1.0)
|
||||
Requires: psycopg
|
||||
|
||||
|
||||
Provides (multiple use) (deprecated)
|
||||
::::::::::::::::::::::::::::::::::::
|
||||
|
||||
**This field is now deprecated in favor of "Provides-Dist"**
|
||||
|
||||
Each entry contains a string describing a package or module that
|
||||
will be provided by this package once it is installed. These
|
||||
strings should match the ones used in Requirements fields. A
|
||||
version declaration may be supplied (without a comparison
|
||||
operator); the package's version number will be implied if none
|
||||
is specified.
|
||||
|
||||
Examples::
|
||||
|
||||
Provides: xml
|
||||
Provides: xml.utils
|
||||
Provides: xml.utils.iso8601
|
||||
Provides: xml.dom
|
||||
Provides: xmltools (1.3)
|
||||
|
||||
|
||||
Obsoletes (multiple use) (deprecated)
|
||||
:::::::::::::::::::::::::::::::::::::
|
||||
|
||||
**This field is now deprecated in favor of "Obsoletes-Dist"**
|
||||
|
||||
Each entry contains a string describing a package or module
|
||||
that this package renders obsolete, meaning that the two packages
|
||||
should not be installed at the same time. Version declarations
|
||||
can be supplied.
|
||||
|
||||
The most common use of this field will be in case a package name
|
||||
changes, e.g. Gorgon 2.3 gets subsumed into Torqued Python 1.0.
|
||||
When you install Torqued Python, the Gorgon package should be
|
||||
removed.
|
||||
|
||||
Example::
|
||||
|
||||
Obsoletes: Gorgon
|
||||
|
||||
|
||||
Requires-Dist (multiple use)
|
||||
::::::::::::::::::::::::::::
|
||||
|
||||
|
|
@ -477,19 +397,6 @@ Examples::
|
|||
Requires-External: libpng (>=1.5)
|
||||
|
||||
|
||||
Copyright
|
||||
:::::::::
|
||||
|
||||
Indicates the party or parties, and the year of copyright
|
||||
covering the package.
|
||||
|
||||
Examples::
|
||||
|
||||
Copyright: Guido van Rossum, 1991
|
||||
Copyright: Python Software Foundation, 2005
|
||||
Copyright: Public Domain
|
||||
|
||||
|
||||
Project-URL (multiple-use)
|
||||
::::::::::::::::::::::::::
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue