Author eric.araujo
Recipients Thomas.Smith, alexis, eric.araujo, ingy, tarek
Date 2011-09-19.14:58:35
SpamBayes Score 1.0537e-07
Marked as misclassified No
Message-id <1316444316.99.0.438615732994.issue11913@psf.upfronthosting.co.za>
In-reply-to
Content
> When I upload modules to PyPI, distutils is clucking about a missing
> README, even though PyPI accepts README.rst, and I am providing that.
PyPI doesn’t do anything with README, it displays the value of long_description.

> warning: sdist: standard file not found: should have one of README, README.txt
Is it a problem to name your reST file README.txt?


In packaging/distutils2, the recommended idiom looks like this (in setup.cfg):

    [metadata]
    description-file = README.whatever

sdist will include that file.  You can also write the description in the setup.cfg directly and have your README file included with the extra_files field.


This can’t be changed in distutils and works differently without warning in distutils2; closing.
History
Date User Action Args
2011-09-19 14:58:37eric.araujosetrecipients: + eric.araujo, tarek, Thomas.Smith, alexis, ingy
2011-09-19 14:58:36eric.araujosetmessageid: <1316444316.99.0.438615732994.issue11913@psf.upfronthosting.co.za>
2011-09-19 14:58:36eric.araujolinkissue11913 messages
2011-09-19 14:58:36eric.araujocreate