Wrong README filename

Issue #3 resolved
Anonymous created an issue

setup.cfg contain: long_description_file = ReadMe.txt doc/changelog.rst

But $ ls altgraph altgraph_tests doc PKG-INFO setup.cfg altgraph.egg-info distribute_setup.py MANIFEST.in README.txt setup.py

ReadMe.txt != README.txt

Comments (4)

  1. Michael Armida

    I just went to add a pull request to fix this, but it looks like the author has since renamed README.txt to ReadMe.txt. So the very latest from tip installs ok, however, that's not yet on PyPI.

  2. Ronald Oussoren repo owner

    I'm not sure what's going on here, it looks like a distutils/distribute problem.

    On my machine I have a file named "ReadMe.txt" (as you saw when creating a checkout of the repository), but when I run "python setup.py sdist" the generated source archive contains a file named "README.txt".

  3. Ronald Oussoren repo owner

    This is "feature" of distutils. When creating the source archive it looks for files named "README" and "README.txt" and adds them when they are found. Because I develop on OSX the file "ReadMe.txt" is detected and added to the source archive.

    IMHO this is a bug in distutils, but I won't bother to report this issue because it is likely that the issue will be closed as "wontfix" because the distutils maintainers consider distutils closed for development.

    I've commited a workaround in issue in d5b57fd29a64

  4. Ronald Oussoren repo owner

    Uploaded version 0.10.1 to PyPI.

    BTW. Thanks for the report, I'm working on a OSX system and therefore didn't notice that the source archive won't work on case sensitive file systems.

  5. Log in to comment