[Catalog-sig] More documentation for setup meta-data
Stuart Bishop
stuart.b@commonground.com.au
Thu, 27 Feb 2003 13:51:46 +1100
On Thursday, February 27, 2003, at 12:18 PM, Richard Jones wrote:
> I'm trying to better document the meta-data for the distutils (and
> hence
> PyPI). I've added words to the section in the dev doc about meta-data,
> and
> would like some feedback before I post the patch to be applied. Sorry,
> it's
> in LaTeX form (until someone writes the ReST->python doc converter ;)
A patch was applied yesterday to dist.tex btw:
https://sourceforge.net/tracker/
?func=detail&atid=105470&aid=693474&group_id=5470
In particular, 'home_page' should be 'url'
I think a definition of 'short string' and 'long string' are required:
- Are Unicode strings allowed?
- What formatting is allowed (eg. none whatsoever for short string,
and ReST for long string)? I think either ReST or an HTML subset
is required for the long description. It would suck if long
description
ended up in a <pre> section on pypi, although this would be usable if
lines were shoved through textwrap.wrap()
It would be benefitial to mandate certain trove classifiers, to make
browsing
usable on pypi (at the moment, about 75% of projects are implemented in
no
language whatsoever!)
How about at least one of:
Development Status :: *
Environment :: *
Intended Audience :: *
License :: *
Operating System :: *
Programming Language :: *
Topic :: *
and possibly to complete the set of top level classifiers:
Natural Language :: * (does this mean the language the docstrings are
written
in, or programs dealing with language
processing?)
--
Stuart Bishop <zen@shangri-la.dropbear.id.au>
http://shangri-la.dropbear.id.au/