Convert README to rst and use for long description on PyPI

[praiskup]

Thank you, the "use README for PyPI" commit merged as e7ffb42a8a8b5a385227516da5d05bfbf5bcf3a5. I don't plan to move the README.md to README.rst, unless that has some mandatory benefits.

[stephenfin]

You need to do more changes to setup.py if you want to use markdown https://stackoverflow.com/questions/26737222/how-to-make-pypi-description-markdown-work

There were more fixes in the rST version, including grammatical fixes, and as noted in the commit message, using rST means things work with older setuptools versions. I'm not sure why you wouldn't use it, tbh, especially when the work is already done, but your call

[praiskup]

You need to do more changes to setup.py if you want to use markdown https://stackoverflow.com/questions/26737222/how-to-make-pypi-description-markdown-work

Tl;dr :-/ what exactly is needed here? I uploaded the tarball with README.md, and it just worked. But it was late in night :-)

There were more fixes in the rST version, including grammatical fixes,

Drat, :-( sorry, I'm interested in that part -- though it wasn't clear, it got lost in the "reformat all" patch.

and as noted in the commit message, using rST means things work with older setuptools versions.

From the change wasn't clear who is affected by this, can you please elaborate on benefits?

I'm not sure why you wouldn't use it, tbh, especially when the work is already done, but your call

Generally, the less changes the patch contains - the better. To preserve history, etc.

[stephenfin]

You need to do more changes to setup.py if you want to use markdown stackoverflow.com/questions/26737222/how-to-make-pypi-description-markdown-work

Tl;dr :-/ what exactly is needed here? I uploaded the tarball with README.md, and it just worked. But it was late in night :-)

I thought you had to add the long_description_content_type='text/markdown' argument to the setup function to ensure PyPI knew the format. Maybe they've added auto-detection code recently or something?

There were more fixes in the rST version, including grammatical fixes,

Drat, :-( sorry, I'm interested in that part -- though it wasn't clear, it got lost in the "reformat all" patch.

Would splitting that patch into a "convert to rST" and a "fix grammar and spelling" patch help?

and as noted in the commit message, using rST means things work with older setuptools versions.

From the change wasn't clear who is affected by this, can you please elaborate on benefits?

As above, I thought you needed to set long_description_content_type which is only supported since setuptools v38.6.0 (commit b2ea3c4a2). If this isn't necessary on PyPI, maybe that's less on an issue.

I'm not sure why you wouldn't use it, tbh, especially when the work is already done, but your call

Generally, the less changes the patch contains - the better. To preserve history, etc.

For sure. I set aside my normal concerns here though since it was just a README (meaning bisecting wasn't likely) and this is GitHub, where most people don't actually look at individual commits :smile: Would have been another story if I was posting to an ML/Gerrit

[praiskup]

I thought you had to add the long_description_content_type='text/markdown' argument to the setup function to ensure PyPI knew the format. Maybe they've added auto-detection code recently or something?

I've added that in 08589f20499921b7af9d8e6bbfc74c4d9eb1285f, yes.

Drat, :-( sorry, I'm interested in that part -- though it wasn't clear, it got lost in the "reformat all" patch.

Would splitting that patch into a "convert to rST" and a "fix grammar and spelling" patch help?

Yes, well - if you could submit just the spelling patch, and keep md format? That would be awesome.

As above, I thought you needed to set long_description_content_type which is only supported since setuptools v38.6.0 (commit b2ea3c4a2). If this isn't necessary on PyPI, maybe that's less on an issue.

Yes, it's non problem - it just works in PyPI (and on my Fedora box as well).