sdist refuses README.rst

[ingy]

BPO	11913
Nosy	@vstinner, @tarekziade, @merwok, @berkerpeksag, @dstufft, @refi64
PRs	bpo-11913: Add README.rst to the distutils standard READMEs #563

^{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

GitHub fields:

assignee = None
closed_at = <Date 2017-04-24.08:40:11.328>
created_at = <Date 2011-04-24.02:48:42.069>
labels = ['3.7', 'type-feature', 'library']
title = 'sdist refuses README.rst'
updated_at = <Date 2017-04-24.08:40:11.316>
user = 'https://bugs.python.org/ingy'

bugs.python.org fields:

activity = <Date 2017-04-24.08:40:11.316>
actor = 'berker.peksag'
assignee = 'none'
closed = True
closed_date = <Date 2017-04-24.08:40:11.328>
closer = 'berker.peksag'
components = ['Distutils']
creation = <Date 2011-04-24.02:48:42.069>
creator = 'ingy'
dependencies = []
files = []
hgrepos = []
issue_num = 11913
keywords = []
message_count = 8.0
messages = ['134322', '134473', '143032', '143151', '144283', '290729', '291643', '292206']
nosy_count = 9.0
nosy_names = ['vstinner', 'tarek', 'eric.araujo', 'Thomas.Smith', 'alexis', 'ingy', 'berker.peksag', 'dstufft', 'refi64']
pr_nums = ['563']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue11913'
versions = ['Python 3.7']

[ingy]

When I upload modules to PyPI, distutils is clucking about a missing README, even though PyPI accepts README.rst, and I am providing that.

Registering pyplay to http://pypi.python.org/pypi
Server response (200): OK
python setup.py sdist upload
running sdist
warning: sdist: standard file not found: should have one of README, README.txt

[merwok]

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.

[ThomasSmith]

Just wanted to note that this confuses other people too...

http://stackoverflow.com/questions/4384796/readme-extension-for-python-projects

Is this something that could be changed in 'distribute'?

[merwok]

distribute is not a project of python-dev, please use their bug tracker.

For distutils, I explained why we can’t change it and proposed a doc change; nobody commented on that.

For distutils2, I’m waiting for a reply from Tarek to this question: why don’t we include README by default anymore?

[merwok]

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.

[refi64]

FWIW, I opened a PR for this: #563

[vstinner]

New changeset f9f87f0 by Victor Stinner (Ryan Gonzalez) in branch 'master':
bpo-11913: Add README.rst to the distutils standard READMEs list (#563)
f9f87f0

[berkerpeksag]

PR 563 has been merged.