[Distutils] README file format and pypi.python.org

[Donald Stufft]

On Sep 22, 2013, at 5:15 PM, PJ Eby <pje at telecommunity.com> wrote:

> On Sun, Sep 22, 2013 at 9:01 AM, Paul G. <paul.list at 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
> 
>> 2. Do I have to use a different extension for the README?
> 
> It doesn't matter, since the README is not read by PyPI.  (You can put
> code in your setup.py to read the file into the long_description
> field, though.  Take a look at other packages' setup.py files to see
> how they do it.)
> _______________________________________________
> Distutils-SIG maillist  -  Distutils-SIG at python.org
> https://mail.python.org/mailman/listinfo/distutils-sig

Oops, I missed this, in some cases PyPI will read a README.rst
(maybe a .txt too), typically if a long_description is not available.

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

-------------- 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/20130922/aa543ac1/attachment.sig>