For eg: https://pypi.python.org/pypi/requests
Credits: @Naereen from https://github.com/MechCoder/mondrian-art/commit/fcb639dbbc055fdb41e8ffc283a18856dbc637be#commitcomment-22325181
I suggest to use pandoc to (possibly automatically) convert the README.md file (as displayed on GitHub) to a README.rst file (to be displayed on PyPi).
I think pypi uses the value of the long_description in setup.py so we also need to modify that to be something like open('README.rst').read().
For dib-lab/khmer we recently switched (back to) rst: https://github.com/dib-lab/khmer/pull/1696 for exactly this reason :)
Exactly. Can someone with write access do this change, instead of a PR, please?
(I remember seeing a large project where the
setup.pyfile used pandoc Python interface to convert theREADME.mdto rST on the fly... but that's way too heavy I think -- and I cannot find it again!)
I can make a PR later to change the README and change the setup.py.