Search code examples
pythonpython-3.xmarkdownsetuptoolspypi

How to let MarkDown based package description show properly on PyPI?

I uploaded a python package to pypi. Following some online examples, I wrote a setup.py script and specified "text/markdown" as long_description_content_type, see the full script here

https://github.com/fangq/pyjdata/blob/master/setup.py

however, the description page on pypi does not display the subtitles and multi-line code properly, see

https://pypi.org/project/jdata/

can someone point me what to change to make this display correctly on PyPI?

Solution

  • You need to upload your package using twine version 1.11 or higher (and not directly using setup.py).

    See https://dustingram.com/articles/2018/03/16/markdown-descriptions-on-pypi/