If it’s only a warning, just ignore it. This would be easy to fix, but as it would be considered a new feature, it can’t go into distutils, which is frozen. I am however willing to edit the documentation to tell that PyPI will accept README.rst and that people need not worry about the unfortunate warning. Would that be okay with you?
In distutils2, the replacement for distutils, we don’t included README by default. I don’t know why this was changed.
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):
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.
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
The text was updated successfully, but these errors were encountered: