From 031bafc6084472025d68a456750387ab418a6cde Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tarek=20Ziad=C3=A9?= Date: Tue, 24 Nov 2009 09:14:32 +0000 Subject: [PATCH] added three fields for the project URLs: Repository-URL, Repository-Browser-URL, Bug-Tracker-URL --- pep-0345.txt | 50 +++++++++++++++++++++++++++++++++++++++----------- pep-0386.txt | 2 +- 2 files changed, 40 insertions(+), 12 deletions(-) diff --git a/pep-0345.txt b/pep-0345.txt index bfcc2f9e0..735d0d307 100644 --- a/pep-0345.txt +++ b/pep-0345.txt @@ -9,7 +9,7 @@ Type: Standards Track Content-Type: text/x-rst Created: 28-Apr-2005 Python-Version: 2.5 -Post-History: +Post-History: Replaces: 314 @@ -162,7 +162,7 @@ Author-email Maintainer (optional) A string containing the maintainer's name at a minimum; additional contact information may be provided. - + Note that this field is intended for use when a package is being maintained by someone other than the original author: it should be omitted if it is identical to ``Author``. @@ -295,7 +295,7 @@ Requires-Dist (multiple use) version numbers, separated by commas. Conditional operators must be one of "<", ">", "<=", ">=", "==", and "!=". Version numbers must be in the format specified in `PEP 386`_. - If no operator is provided with a version, the "==" operator + If no operator is provided with a version, the "==" operator is used by default. Any number of conditional operators can be specified, e.g. @@ -326,7 +326,7 @@ Provides-Dist (multiple use) RDBMS bindings for use by a given ORM: each project might declare that it provides ``ORM-bindings``, allowing other projects to depend only on having at most one of them installed. - + A version declaration may be supplied (without a comparison operator); the distribution's version number will be implied if none is specified. Version numbers must be in the format specified in @@ -342,7 +342,7 @@ Obsoletes-Dist (multiple use) Each entry contains a string describing a distutils project which this package renders obsolete, meaning that the two packages should not be installed at the same time. - + Version declarations can be supplied. Version numbers must be in the format specified in `PEP 386`_. @@ -387,10 +387,10 @@ Requires-External (multiple use) A version declaration is a series of conditional operators and version numbers, separated by commas. Conditional operators - must be one of "<", ">", "<=", ">=", "==", and "!=". If no + must be one of "<", ">", "<=", ">=", "==", and "!=". If no operator is provided with a version, the "==" operator is used by default. - Because they refer to non-Python software releases, version numbers + Because they refer to non-Python software releases, version numbers for this field are **not** required to conform to the format specified in `PEP 386`_: they should correspond to the version scheme used by the external dependency. @@ -416,6 +416,31 @@ Copyright Copyright: Python Software Foundation, 2005 Copyright: Public Domain + +Repository-URL + A string containing the URL for the project repository. + + Example:: + + Repository-URL: http://svn.python.org/projects/python/trunk/ + + +Repository-Browse-URL + A string containing the URL for the project browsable repository. + + Example:: + + Repository-Browse-URL: http://svn.python.org/view/python/trunk + + +Bug-Tracker-URL + A string containing the URL for the package's bug tracker + + Example:: + + Bug-Tracker-URL: http://bugs.python.org/ + + Version Specifiers ================== @@ -432,13 +457,13 @@ environment. Here are some example of fields using such markers:: - Requires-Dist: pywin32, bar > 1.0; sys.platform == 'win32' + Requires-Dist: pywin32 > 1.0; sys.platform == 'win32' Obsoletes-Dist: pywin31; sys.platform == 'win32' Requires-Dist: foo; os.machine == 'i386' Requires-Dist: bar; python_version == '2.4' or python_version == '2.5' Requires-External: libxslt; 'linux' in sys.platform -These markers are using a micro-language that can be interpreted using a +These markers are using a micro-language that can be interpreted using a function ``interpret_marker`` provided in the ``distutils.util`` module in the stdlib:: @@ -446,7 +471,7 @@ in the stdlib:: >>> interpret_marker("sys.platform == 'win32'") True -Depending if the execution environment meets the requirements, the function +Depending if the execution environment meets the requirements, the function will return True or False. The micro-language behind this is the simplest possible: it compares only @@ -496,6 +521,9 @@ Summary of Differences From PEP 314 - Requires-Dist - Provides-Dist - Obsoletes-Dist + - Repository-URL + - Repository-Browser-URL + - Bug-Tracker-URL * Deprecated fields: @@ -532,7 +560,7 @@ Acknowledgements Fred Drake, Anthony Baxter and Matthias Klose have all contributed to the ideas presented in this PEP. -Tres Seaver, Jim Fulton, Marc-André Lemburg, Tarek Ziadé and other people at +Tres Seaver, Jim Fulton, Marc-André Lemburg, Tarek Ziadé and other people at the Distutils-SIG have contributed to the new updated version. diff --git a/pep-0386.txt b/pep-0386.txt index 67ac04277..50aa9ef0b 100644 --- a/pep-0386.txt +++ b/pep-0386.txt @@ -283,7 +283,7 @@ post-releases -- which apparently is used by a number of projects out there be a ``1.2.0-r678`` release. We used ``post`` instead of ``r`` because the ``r`` is ambiguous as to whether it indicates a pre- or post-release. -Last, ``.post456.dev34`` indicates a dev parker for a post release, that sorts +Last, ``.post456.dev34`` indicates a dev marker for a post release, that sorts before a ``.post345`` marker. This can be used to do development versions of post releases.