Add Documentation URL for PyPI and use README to power long_description

[andriyor]

Warehouse now uses the project_urls provided to display links in the sidebar as well as including them in API responses. For example, see Django's setup.cfg and PyPI listing.

PyPI also already support rendering project descriptions from Markdown https://dustingram.com/articles/2018/03/16/markdown-descriptions-on-pypi/

[mahmoud]

Sounds good to me! As you can see, the CI job that checks packaging coherence is failing right now. I recommend bumping the deps in the tox.ini under that name (the versions in there are around 2 years old!), and running the tox locally, if you can. There may need to be some markdown fixup that happens because GitHub is more lenient than PyPI.

[codecov]

Codecov Report

Merging #122 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #122   +/-   ##
=======================================
  Coverage   96.61%   96.61%           
=======================================
  Files          19       19           
  Lines        2511     2511           
  Branches      362      362           
=======================================
  Hits         2426     2426           
  Misses         45       45           
  Partials       40       40

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 12e0555...8ed9a88. Read the comment docs.

[andriyor]

Seems like readme checker need only for reStructuredText
https://packaging.python.org/guides/making-a-pypi-friendly-readme/#validating-restructuredtext-markup

[mahmoud]

Seems like readme checker need only for reStructuredText
https://packaging.python.org/guides/making-a-pypi-friendly-readme/#validating-restructuredtext-markup

Interesting, so it doesn't give any valuable feedback on the current readme? Might be nice to have some checking because it's pretty annoying to have to rev versions just to fix the docs, which is usually why I keep them really simple on PyPI :)

[mahmoud]

Well I think that's all my concerns resolved. This has been very helpful, thank you so much!

[mahmoud]

I'll follow up and fix up the URLs in the readme to be compatible (absolute, pointing at github raw) before the next release (unless you want to take a stab at it!) :)