Distutils register command and reStructuredText
Hello Right now most people in the community uses reST for their long_description metadata. It looks good in PyPI since it's displayed in HTML. But if the reST is broken, it does not look right. (which happen regularly) I'd like to add an option in the register command that would verify that the text is compiling well using docutils Any opinion on this ? Cheers Tarek -- Tarek Ziadé | Association AfPy | www.afpy.org Blog FR | http://programmation-python.org Blog EN | http://tarekziade.wordpress.com/
On Apr 5, 2009, at 5:12 PM, Tarek Ziadé wrote:
Any opinion on this ?
I'm +0.5 on it as I'm inclined to think that a "./setup.py check" may be in order for things like this. Although, wouldn't such a check require a dependency on docutils? Or would this be a pypi, catalog, feature? That is, I have been bitten by this, so some feedback from the tool would be handy.. An alternative may be to explicitly upload a long_description via the web interface where the user can get a preview prior to publishing it..
On Mon, Apr 6, 2009 at 2:41 AM, James Pye
On Apr 5, 2009, at 5:12 PM, Tarek Ziadé wrote:
Any opinion on this ?
I'm +0.5 on it as I'm inclined to think that a "./setup.py check" may be in order for things like this.
I guess you can already do this with: $ python setup.py --long-description | rst2html.py > /dev/null you'll get any warning/error in the stdout.
Although, wouldn't such a check require a dependency on docutils? Or would this be a pypi, catalog, feature?
A docutils dependency, on client side, trigger at register time, if docutils is installed.
That is, I have been bitten by this, so some feedback from the tool would be handy..
An alternative may be to explicitly upload a long_description via the web interface where the user can get a preview prior to publishing it..
Maybe so. That said, I (and the people I know); never use the web UI to register/upload a package at PyPI the command line is faster Cheers Tarek -- Tarek Ziadé | Association AfPy | www.afpy.org Blog FR | http://programmation-python.org Blog EN | http://tarekziade.wordpress.com/
On Mon, Apr 06, 2009 at 02:12:58AM +0200, Tarek Ziadé wrote:
Right now most people in the community uses reST for their long_description metadata. It looks good in PyPI since it's displayed in HTML.
But if the reST is broken, it does not look right. (which happen regularly)
I'd like to add an option in the register command that would verify that the text is compiling well using docutils
I assume by "verify" you mean it would fail register if setup.py passes something like long_description_format="reST" to setup()? +1 Marius Gedminas -- ultimate_answer_t deep_thought(void) { sleep(years2secs(7500000)); return 42; } -- ConceptJunkie on Slashdot
participants (3)
-
James Pye
-
Marius Gedminas
-
Tarek Ziadé