iSharkFly-Open
/
python-peps
mirror of https://github.com/python/peps.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Reformat examples. Make the 'Description' example clearer. 

Add 'Acknowledgements' section
This commit is contained in:
Andrew M. Kuchling 2001-03-20 15:48:10 +00:00
parent 9fff8bede1
commit 5a1d457245
1 changed files with 60 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
pep-0241.txt
View File

@ -51,13 +51,17 @@ Fields
Version of the file format; currently "1.0" is the only Version of the file format; currently "1.0" is the only
legal value here. legal value here.
Example: 'Metadata-Version: 1.0' Example:
Metadata-Version: 1.0
Name Name
The name of the package. The name of the package.
Example: 'Name: BeagleVote' Example:
Name: BeagleVote
Version Version
@ -66,7 +70,9 @@ Fields
(StrictVersion or LooseVersion) in the distutils.version (StrictVersion or LooseVersion) in the distutils.version
module. module.
Example: 'Version: 1.0a2' Example:
Version: 1.0a2
Platform (multiple use) Platform (multiple use)
@ -82,13 +88,17 @@ Fields
package was compiled. The semantics of the Supported-Platform package was compiled. The semantics of the Supported-Platform
are not specified in this PEP. are not specified in this PEP.
Example: 'Platform: POSIX, Windows' Example:
Platform: POSIX, Windows
Summary Summary
A one-line summary of what the package does. A one-line summary of what the package does.
Example: "Summary: A module for collecting votes from beagles." Example:
Summary: A module for collecting votes from beagles.
Description (optional) Description (optional)
@ -98,23 +108,29 @@ Fields
people won't include their instruction manual as the people won't include their instruction manual as the
long-description.) long-description.)
Example: "Description: This module collects votes from beagles\n Example:
in order to determine their electoral wishes.\n
Do NOT try to use this module with basset hounds; Description: This module collects votes from beagles
it makes them grumpy." in order to determine their electoral wishes.
Do NOT try to use this module with basset hounds;
it makes them grumpy.
Keywords (optional) Keywords (optional)
A list of additional keywords to be used to assist searching A list of additional keywords to be used to assist searching
for the package in a larger catalog. for the package in a larger catalog.
Example: 'Keywords: dog puppy voting election' Example:
Keywords: dog puppy voting election
Home-page (optional) Home-page (optional)
A string containing the URL for the package's home page. A string containing the URL for the package's home page.
Example: 'Home-page: http://www.example.com/~cschultz/bvote/' Example:
Home-page: http://www.example.com/~cschultz/bvote/
Author (optional) Author (optional)
@ -122,9 +138,11 @@ Fields
information can also be added, separating each line with information can also be added, separating each line with
newlines. newlines.
Example: 'Author: C. Schultz Example:
Universal Features Syndicate
Los Angeles, CA' Author: C. Schultz
Universal Features Syndicate
Los Angeles, CA
Author-email Author-email
@ -139,7 +157,9 @@ Fields
person. Author-related metadata fields are not covered by this person. Author-related metadata fields are not covered by this
PEP. PEP.
Example: 'Author-email: "C. Schultz" <cschultz@example.com>' Example:
Author-email: "C. Schultz" <cschultz@example.com>
License License
@ -153,13 +173,21 @@ Fields
The choices are: The choices are:
Artistic, BSD, DFSG, GNU PL, Lesser GNU PL, "MIT/X11", Artistic, BSD, DFSG, GNU GPL, GNU LGPL, "MIT/X11",
Mozilla PL, "public domain", Python, Qt PL, Zope PL, unknown, Mozilla PL, "public domain", Python, Qt PL, Zope PL, unknown,
nocommercial, nosell, nosource, shareware, other nocommercial, nosell, nosource, shareware, other
The definitions are: Definitions of some of the licenses are:
DFSG The license conforms to the Debian Free Software
Guidelines, but does not use one of the other
DFSG conforming licenses listed here.
More information is available at:
http://www.debian.org/social_contract#guidelines
Python Python 1.6 or higher license. Version 1.5.2 and Python Python 1.6 or higher license. Version 1.5.2 and
earlier are under the MIT/X11 license. earlier are under the MIT/X11 license.
public domain Software is public domain, not copyrighted. public domain Software is public domain, not copyrighted.
unknown Status is not known unknown Status is not known
nocommercial Free private use but commercial use not permitted nocommercial Free private use but commercial use not permitted
@ -171,7 +199,7 @@ Fields
Some of these licenses can be interpreted to mean the software is Some of these licenses can be interpreted to mean the software is
freely redistributable. The list of redistributable licenses is: freely redistributable. The list of redistributable licenses is:
Artistic, BSD, DFSG, GNU PL, Lesser GNU PL, "MIT/X11", Artistic, BSD, DFSG, GNU GPL, GNU LGPL, "MIT/X11",
Mozilla PL, "public domain", Python, Qt PL, Zope PL, Mozilla PL, "public domain", Python, Qt PL, Zope PL,
nosource, shareware nosource, shareware
@ -179,9 +207,22 @@ Fields
qualifies as free software, 'nosource' and 'shareware' being qualifies as free software, 'nosource' and 'shareware' being
examples. examples.
Example: 'License: MIT/X11' Example:
License: MIT/X11
Acknowledgements
Many changes and rewrites to this document were suggested by the
readers of the Distutils SIG. In particular, Sean Reifschneider
often contributed actual text for inclusion in this PEP.
The list of licenses was compiled using the SourceForge license
list and the CTAN license list compiled by Graham Williams; Carey
Evans also offered several useful suggestions on this list.
Copyright Copyright
This document has been placed in the public domain. This document has been placed in the public domain.