Specify markdown README for PyPI's long_description

[dhimmel]

Set long_description_content_type='text/markdown' in setup.py. I believe this should trigger the README to display with proper formatting on PyPI. Currently, PyPI looks like:

Refs https://packaging.python.org/tutorials/distributing-packages/#description and https://dustingram.com/articles/2018/03/16/markdown-descriptions-on-pypi.

[coveralls]

Coverage remained the same at 85.992% when pulling f157a09 on dhimmel:patch-1 into 32e2f01 on warner:master.

[coveralls]

Coverage remained the same at ?% when pulling 652fc01 on dhimmel:patch-1 into ffe9a61 on warner:master.

[dhimmel]

@di is this pull request necessary for PyPI to render the README as markdown? Note that setup.py never sets long_description. I believe PyPI is recognizing the README from

https://github.com/warner/python-ecdsa/blob/ffe9a61390c76ff6f6636e29f26b45c900535aaf/MANIFEST.in#L2

If that's the case, will PyPI automatically use markdown formatting on the next release because of the .md extension?

[di]

If that's the case, will PyPI automatically use markdown formatting on the next release because of the .md extension?

@dhimmel No, you will need to set long_description_content_type. I would also recommend explicitly setting long_description as well, certain tools do not actually have the behavior you're describing.

(In fact, if this is happening for you now, I'd be curious what you're using to build/publish the distribution.)

Also, you're likely already aware, but you can use https://test.pypi.org/ to ensure that everything's set up correctly before actually making a new release on PyPI.

[di]

Actually it seems like if you're using flit this might not actually be necessary, @takluyver would know for sure.

[takluyver]

Yup, with flit you point to a file for the description (like this), and it uses the extension to select the content type appropriately (.rst, .md or .txt).

[dhimmel]

Yup, with flit you point to a file for the description, and it uses the extension to select the content type appropriately (.rst, .md or .txt).

Cool. So I'm not actually involved with this repository and am not sure if flit is being used. If it is, I'll close this PR. How do you find out?

[takluyver]

It's not - if flit is in use, the repository will contain either a pyproject.toml (with the word flit in it) or flit.ini.

[dhimmel]

I would also recommend explicitly setting long_description as well, certain tools do not actually have the behavior you're describing.

Let's wait for a project maintainer. Happy to make it so setup.py sets long_description to the text of README.md in this PR if that's requested.

[tomato42]

please update it so that long_description is set and rebase on top of current master (few tools deprecated py3.3, so just updating the PR will cause Travis tests to fail)

[dhimmel]

0118ab4 is the rebased commit. Will set long_description in next commit.

[dhimmel]

please update it so that long_description is set

Done in f157a09

[tomato42]

Perfect, thank you!