Support Markdown for readmes (fixes #148)

#33 Merged at 0839af8
Repository
hickford
Branch
markdown-readme
Repository
pypa
Branch
default
Author
  1. Hickford
Reviewers
Description

This pull request adds a third step to PyPI's readme discovery algorithm:

  1. Try to use long_description from setup.py
  2. If that doesn't exist, look for nearby readme.rst
  3. If that doesn't exist, look for nearby readme.md

Comments (18)

  1. Richard Jones

    I have reverted the merge of this commit. It does not address any of the security concerns covered by the ReStructuredText rendering:

    1. raw html is apparently allowed
    2. no restriction on links, so I believe the javascript scheme is allowed.

    I'm not familiar enough with Markdown to know what other security holes there might be in a naive implementation as was proposed here.

  2. Marc Abramowitz

    Is there a way in Bitbucket to get rid of the big green Screen Shot 2014-12-08 at 10.07.56 AM.png indicator for this PR? I fear that people will find this, see that it says "Merged" and then get all excited for nothing.

    1. Richard Jones

      No, you can't have that removed because the PR is still merged, even though I reverted the changes. A new PR should be opened for any subsequent submission.