I added the use of README to catch all the github users who weren't filling in their long_description (but also weren't using Markdown - I just didn't find the time to also add something to detect Markdown and render it).

On 23 September 2013 08:01, Chris Jerdonek <chris.jerdonek@gmail.com> wrote:
On Sun, Sep 22, 2013 at 2:15 PM, PJ Eby <pje@telecommunity.com> wrote:
> On Sun, Sep 22, 2013 at 9:01 AM, Paul G. <paul.list@isrcomputing.com> wrote:
>> 1. What format should I use in my README.txt file for my package's content
>> to be displayed on its package page?
> It's not the README file; it's the package's "long_description"
> keyword, as specified in your setup.py setup() call.  And the format
> is reStructuredText

For the record, the Python documentation covers this aspect of PyPI:


It also includes some troubleshooting info.  However, it doesn't
include anything about PyPI reading README.rst, etc if
long_description isn't available (which maybe should be added).

Distutils-SIG maillist  -  Distutils-SIG@python.org