Skip to content

sdist refuses README.rst #56122

Closed
Closed
sdist refuses README.rst#56122
Labels
3.7 (EOL)end of lifestdlibStandard Library Python modules in the Lib/ directorytype-featureA feature request or enhancement

Description

@ingy
ingy
mannequin
opened on Apr 24, 2011
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']

    Activity

    1. ingy commented on Apr 24, 2011

      @ingy
      ingymannequin
      on Apr 24, 2011
      MannequinAuthor

      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

    2. ingy
      assigned
      tarekziade
      on Apr 24, 2011
    3. ingy
      added
      type-bugAn unexpected behavior, bug, or error
      stdlibStandard Library Python modules in the Lib/ directory
      on Apr 24, 2011

    4. merwok commented on Apr 26, 2011

      @merwok
      merwok
      on Apr 26, 2011
      Member

      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.

    5. ThomasSmith commented on Aug 26, 2011

      @ThomasSmith
      ThomasSmithmannequin
      on Aug 26, 2011
      Mannequin

      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'?

    6. merwok commented on Aug 29, 2011

      @merwok
      merwok
      on Aug 29, 2011
      Member

      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?

    7. merwok
      changed the title [-]sdist should allow for README.rst[/-] [+]sdist refuses README.rst[/+] on Aug 29, 2011

    8. merwok commented on Sep 19, 2011

      @merwok
      merwok
      on Sep 19, 2011
      Member

      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.

    9. merwok
      closed this as completedon Sep 19, 2011
    10. merwok
      assigned
      merwok
      and unassigned
      tarekziade
      on Sep 19, 2011
    11. pitrou
      reopened this on Mar 27, 2017

    12. refi64 commented on Mar 28, 2017

      @refi64
      refi64mannequin
      on Mar 28, 2017
      Mannequin

      FWIW, I opened a PR for this: #563

    13. vstinner commented on Apr 14, 2017

      @vstinner
      vstinner
      on Apr 14, 2017
      Member

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

    14. berkerpeksag commented on Apr 24, 2017

      @berkerpeksag
      berkerpeksag
      on Apr 24, 2017
      Member

      PR 563 has been merged.

    15. berkerpeksag
      added
      3.7 (EOL)end of life
      on Apr 24, 2017
    16. berkerpeksag
      closed this as completedon Apr 24, 2017
    17. berkerpeksag
      unassigned
      merwok
      on Apr 24, 2017
    18. berkerpeksag
      added
      type-featureA feature request or enhancement
      and removed
      type-bugAn unexpected behavior, bug, or error
      on Apr 24, 2017
    19. ezio-melotti
      transferred this issue fromon Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Assignees

    No one assigned

      Labels

      3.7 (EOL)end of lifestdlibStandard Library Python modules in the Lib/ directorytype-featureA feature request or enhancement

      Projects

      No projects

        Milestone

        No milestone

        Relationships

        None yet

        Development

        No branches or pull requests

        Issue actions