Specify Description-Content-Type in Pypi upload for markdown README

Viewed 503

According to PyPA Specifications it should be possible to use markdown formatted README files when uploading to Pypi.

What I don't quite understand is where to put this configuration line. I suspect it has to be PKG-INFO but a) it doesn't work (I added it manually after setup.py dist) and b) I don't think it's intended to be added manually.

What I also did is to add the README.md in the Manifest.in

include README.md

and specify it in setup.cfg:

[metadata]
description-file = README.md

You can have a look at my repo here.

However, there's nothing being displayed on pypi, as if there was no README.

I am fully aware that RST is the recommended way and most stuff on the web is about how to convert MD to RST, which didn't work for me neither (possibly due to incompatible RST versions). According to this blog post and mentionned PyPA Specifications it should be possible to use markdown and I would very much like to do that.

1 Answers

Brief: (fixed)

long-description-content-type = text/markdown

UPDATE

The prb description isn't correct

Checkout my project as reference. On test.pypi and the source on github.

Related