[Distutils] patch: document "Framework :: Setuptools Plugin" and conventions for revision control plugins

zooko zooko at zooko.com
Mon Aug 11 19:43:42 CEST 2008


Part of this patch documents the existence of the "Framework ::  
Setuptools Plugin" classifier and says when to use it.

Another part documents the naming conventions which the developers of  
the various revision control plugins agreed to.



P.S.  Note that the git and hg revision control plugins didn't yet go  
through a renaming to conform to the agreed convention.  I did for  
the setuptools_darcs plugin that I maintain -- you can see the  
leftover evidence of it here:


I'm Cc:'ing the maintainers of the setuptools-git and setuptools-hg  
plugins to remind them of the existence of this convention in case  
they want to switch.

diff -rN -u old-dw/setuptools.txt new-dw/setuptools.txt
--- old-dw/setuptools.txt	2008-08-11 11:38:07.000000000 -0600
+++ new-dw/setuptools.txt	2008-08-11 11:38:07.000000000 -0600
@@ -2384,6 +2384,16 @@
  how setuptools' own commands are installed: the setuptools  
project's setup
  script defines entry points for them!

+If your command would be useful to other Python developers, then  
+uploading it to the `Python Package Index`_.  If you do, please  
include the
+Trove Classifier "Framework :: Setuptools Plugin" in the classifiers  
so that
+your command will appear in the list of `packages which are setuptools
+.. _Python Package Index: http://pypi.python.org/pypi
+.. _packages which are setuptools plugins: http://pypi.python.org/ 

  Adding ``setup()`` Arguments
@@ -2546,6 +2556,17 @@
    control system itself.  It *may*, however, use  
``distutils.log.warn()`` to
    inform the user of the missing program(s).

+Please model your naming conventions and documentation after the other
+setuptools revision control plugins: `setuptools_bzr`_,  
+`setuptools_darcs`_.  Please include the Trove Classifier "Framework ::
+Setuptools Plugin" in the classifiers so that your command will  
appear in the
+list of `packages which are setuptools plugins`_.
+.. _setuptools_bzr: http://pypi.python.org/pypi/setuptools_bzr
+.. _setuptools_mtn: http://pypi.python.org/pypi/setuptools_mtn
+.. _setuptools_darcs: http://pypi.python.org/pypi/setuptools_darcs
+.. _packages which are setuptools plugins: http://pypi.python.org/ 

  Subclassing ``Command``
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: doc-classifier-and-rcs.diff.txt
URL: <http://mail.python.org/pipermail/distutils-sig/attachments/20080811/e57d27c9/attachment.txt>

More information about the Distutils-SIG mailing list