Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sdist refuses README.rst #56122

Closed
ingy mannequin opened this issue Apr 24, 2011 · 8 comments
Closed

sdist refuses README.rst #56122

ingy mannequin opened this issue Apr 24, 2011 · 8 comments
Labels
3.7 stdlib type-feature

Comments

@ingy
Copy link
Mannequin

@ingy ingy mannequin commented Apr 24, 2011

BPO 11913
Nosy @vstinner, @tarekziade, @merwok, @berkerpeksag, @dstufft, @refi64
PRs
  • #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
    Copy link
    Mannequin Author

    @ingy ingy mannequin commented Apr 24, 2011

    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

    @ingy ingy mannequin assigned tarekziade Apr 24, 2011
    @ingy ingy mannequin added type-bug stdlib labels Apr 24, 2011
    @merwok
    Copy link
    Member

    @merwok merwok commented Apr 26, 2011

    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
    Copy link
    Mannequin

    @ThomasSmith ThomasSmith mannequin commented Aug 26, 2011

    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
    Copy link
    Member

    @merwok merwok commented Aug 29, 2011

    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 merwok changed the title sdist should allow for README.rst sdist refuses README.rst Aug 29, 2011
    @merwok
    Copy link
    Member

    @merwok merwok commented Sep 19, 2011

    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.

    @merwok merwok closed this as completed Sep 19, 2011
    @merwok merwok assigned merwok and unassigned tarekziade Sep 19, 2011
    @pitrou pitrou reopened this Mar 27, 2017
    @refi64
    Copy link
    Mannequin

    @refi64 refi64 mannequin commented Mar 28, 2017

    FWIW, I opened a PR for this: #563

    @vstinner
    Copy link
    Member

    @vstinner vstinner commented Apr 14, 2017

    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
    Copy link
    Member

    @berkerpeksag berkerpeksag commented Apr 24, 2017

    PR 563 has been merged.

    @berkerpeksag berkerpeksag added type-feature and removed type-bug labels Apr 24, 2017
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    3.7 stdlib type-feature
    Projects
    None yet
    Development

    No branches or pull requests

    4 participants