[Distutils] PyPI not rendering ReST long_description

[Donald Stufft]

On Jul 13, 2014, at 4:35 PM, Wichert Akkerman <wichert at wiggy.net> wrote:

>> 
>> On 13 Jul 2014, at 21:36, Chris Jerdonek <chris.jerdonek at gmail.com> wrote:
>> 
>> On Sun, Jul 13, 2014 at 9:04 AM, Wichert Akkerman <wichert at wiggy.net> wrote:
>>> I just uploaded a new pyramid_sqlalchemy package to PyPI. Looking at the
>>> distribution page at https://pypi.python.org/pypi/pyramid_sqlalchemy PyPI is
>>> not rendering ReST. I can’t figure out why though: according to both “python
>>> setup.py check” and "python setup.py --long-description | rst2html-2.7.py >
>>> /dev/null” there are no ReST syntax errors in me description. Is there any
>>> way to see why PyPI is not rendering my ReST?
>> 
>> I filed a PyPI issue about this some time before July 2012.
>> 
>> It bothers me that I can't seem to find the issue listed on the
>> current PyPI issues page: https://bitbucket.org/pypa/pypi/issues .  It
>> also disturbs me that I can't seem to find the issue on the old
>> SourceForge page either: http://sourceforge.net/projects/pypi/ .
> 
> That is somewhat worrying. I created a new ticket for this: https://bitbucket.org/pypa/pypi/issue/161/rest-formatting-fails-and-there-is-no-way
> 
>> 
>> 3) The user should have some way of running the conversion locally (as
>> a check), using the same rules as PyPI, so the user can be assured in
>> advance that the conversion will be successful when interacting with
>> the real PyPI.
> 
> I don’t believe that is a viable approach. I suspect there is a reasonable risk that environment changes between PyPI and your local system, for example environment settings or available locals, and using different versions of packages such as docutils will lead to incorrect results. There really is no substitute for PyPI itself reporting errors it finds.
> 
> Wichert.
> 
> _______________________________________________
> Distutils-SIG maillist  -  Distutils-SIG at python.org
> https://mail.python.org/mailman/listinfo/distutils-sig


Currently PyPI has no method to report that it has failed except to fail the upload with a message. This isn’t acceptable because we don’t mandate ReST and some people want to just have plain text uploads. With PyPI/Metadata 2.0 this is getting resolved in a way that’ll make all of this possible as well as additional renderers.

-----------------
Donald Stufft
PGP: 0x6E3CBCE93372DCFA // 7C6B 7C5D 5E2B 6356 A926 F04F 6E3C BCE9 3372 DCFA

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/distutils-sig/attachments/20140713/6550e17f/attachment-0001.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 801 bytes
Desc: Message signed with OpenPGP using GPGMail
URL: <http://mail.python.org/pipermail/distutils-sig/attachments/20140713/6550e17f/attachment-0001.sig>