[Python-checkins] CVS: python/nondist/peps pep-0241.txt,1.2,1.3
A.M. Kuchling
akuchling@users.sourceforge.net
Thu, 15 Mar 2001 10:16:45 -0800
Update of /cvsroot/python/python/nondist/peps
In directory usw-pr-cvs1:/tmp/cvs-serv29757
Modified Files:
pep-0241.txt
Log Message:
Rename METADATA file to PKG-INFO
Specify RFC-822 as the format
Add Metadata-Version field (must be 1.0)
Rename Description->Summary, Long-Description->Description
Remove some XXXs for keywords and author data.
Slightly reword the text about using the e-mail address as a key
Fix incorrect example for author-email
Add list of licenses
Index: pep-0241.txt
===================================================================
RCS file: /cvsroot/python/python/nondist/peps/pep-0241.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** pep-0241.txt 2001/03/13 16:09:08 1.2
--- pep-0241.txt 2001/03/15 18:16:43 1.3
***************
*** 18,39 ****
The Distutils 'sdist' command will be modified to extract the
metadata fields from the arguments and write them to a file in the
! generated zipfile or tarball. This file will be named METADATA
and will be placed in the top directory of the source
distribution (where the README, INSTALL, and other files usually
go).
! Authors might expect to include a METADATA file of their own that
! would be used instead of the generated file, but this will not be
! permitted. It would be confusing if person B makes a custom
! release of person A's software, modifies setup.py accordingly, but
! uses identical metadata because person B didn't delete the
! METADATA file. When running the 'sdist' command, a user-supplied
! METADATA file will be ignored and a warning about this action will
! be printed.
! XXX are we sure RFC-822 is enough?
! The METADATA file format is a single set of RFC-822 headers
parseable by the rfc822.py module. The field names listed in the
! following section are used as the header names.
--- 18,36 ----
The Distutils 'sdist' command will be modified to extract the
metadata fields from the arguments and write them to a file in the
! generated zipfile or tarball. This file will be named PKG-INFO
and will be placed in the top directory of the source
distribution (where the README, INSTALL, and other files usually
go).
! Developers may not provide their own "METADATA" file. The "sdist"
! command will, if it detects an existing "METADATA" file, terminate
! with an appropriate error message. This should prevent confusion
! caused by the "METADATA" and "setup.py" files being out of sync.
! The PKG-INFO file format is a single set of RFC-822 headers
parseable by the rfc822.py module. The field names listed in the
! following section are used as the header names. There's no
! extension mechanism in this simple format; the Catalog and Distutils
! SIGs will aim at getting a more flexible format ready for Python 2.2.
***************
*** 42,49 ****
This section specifies the names and semantics of each of the
supported metadata fields.
!
Name
! The name of the package. XXX what's the set of legal characters?
Example: 'BeagleVote'
--- 39,53 ----
This section specifies the names and semantics of each of the
supported metadata fields.
!
! Metadata-Version
!
! Version of the file format; currently "1.0" is the only
! legal value here.
!
! Example: '1.0'
!
Name
! The name of the package.
Example: 'BeagleVote'
***************
*** 68,72 ****
Example: 'XXX'
! Description
A one-line summary of what the package does.
--- 72,76 ----
Example: 'XXX'
! Summary
A one-line summary of what the package does.
***************
*** 74,78 ****
Example: "A module for collecting votes from beagles."
! Long-Description (optional)
A longer description of the package that can run to several
--- 78,82 ----
Example: "A module for collecting votes from beagles."
! Description (optional)
A longer description of the package that can run to several
***************
*** 91,99 ****
for this package in a larger catalog.
- XXX Keywords should probably be constrained to be from a fixed
- list, but I don't think this can be enforced by the 'sdist'
- command. (The list might be large, and it could only be updated
- with new Distutils releases, which seems too inflexible.)
-
Example: 'dog puppy voting election'
--- 95,98 ----
***************
*** 116,129 ****
A string containing the author's e-mail address. It can contain
a name and e-mail address in the legal forms for a RFC-822
! 'From:' header ("name <email>" or "email (name)"). It's not
! optional because cataloging systems can use the e-mail portion
! of this field as a unique key representing the author. A
! catalog might provide authors the ability to store their GPG
! key, personal home page, and other additional metadata *about
! the author*. Author-related metadata fields are not covered by
! this PEP. (XXX should they be? I think not, since nothing in
! this PEP will deal with author data at all.)
! Example: 'C. Schultz <cschultz@example.com>'
License
--- 115,128 ----
A string containing the author's e-mail address. It can contain
a name and e-mail address in the legal forms for a RFC-822
! 'From:' header. It's not optional because cataloging systems
! can use the e-mail portion of this field as a unique key
! representing the author. A catalog might provide authors the
! ability to store their GPG key, personal home page, and other
! additional metadata *about the author*, and optionally the
! ability to associate several e-mail addresses with the same
! person. Author-related metadata fields are not covered by this
! PEP.
! Example: '"C. Schultz" <cschultz@example.com>'
License
***************
*** 139,143 ****
The choices are:
! XXX copy list from SourceForge, + 'Other'
--- 138,143 ----
The choices are:
! Artistic, BSD, GPL, LGPL, "MIT/X11", MPL, "public domain",
! Python, QPL, ZPL, other