Markdown on PyPI - Githubissues

Teemu / pytest-sugar

a plugin for py.test that changes the default look and feel of py.test (e.g. progressbar, show tests that fail instantly)

Other

1.31k stars 73 forks source link

Markdown on PyPI #207

Closed MartinThoma closed 1 year ago

MartinThoma commented 4 years ago

When I go to the pytest-sugar page on PyPI, I see that markdown is not rendered. The version there is 0.9.4 and if there were no other changes, this version was introduced with 92ae9dee - the latest commit.

I'm uncertain why markdown is not rendered, though. I have a similar setup for my packages and they look fine. Does anybody here have an idea?

Teemu commented 4 years ago

Interesting, I don't know what's going on with that. I read the documentations and I have the markdown tag correctly there.

MartinThoma commented 4 years ago

@Teemu Could you please answer the questions in the other issue? pypa/warehouse is the official repository of pypi.org; so the folks there should be able to give awesome support :-)

mgedmin commented 4 years ago

From my previous encounters with this kind of problem, you need a few things in order to use Markdown descriptions on PyPI:

a long_description_content_type="text/markdown" in your setup.py (which you have)
a sufficiently recent setuptools version used to build the sdist (can't find an exact version number, sorry!)
a sufficiently recent twine version (>= 1.11) used to upload the sdist to PyPI

If you're uploading wheels, it might also be a good idea that you have the most recent wheel version as well.

Anyway I've looked at the two PKG-INFO files inside pytest-sugar-0.9.4.tar.gz and neither of them has the

Description-Content-Type: text/markdown

field, which indicates that you used a too-old setuptools version to generate the sdist.

(and now I see that I merely repeated the information already provided on the linked warehouse issue)

MartinThoma commented 4 years ago

@Teemu Could you answer the questions in https://github.com/pypa/warehouse/issues/8472 about the pytest-sugar build? Maybe they can help us to fix it.

pradyunsg commented 4 years ago

field, which indicates that you used a too-old setuptools version to generate the sdist.

I'm 100% sure that this was the case. :)

I suggest running twine check on the distributions before uploading them (which prints the warning about the lack of this information).

justinmayer commented 1 year ago

It appears Markdown is rendering properly for the pytest-sugar README on its PyPI page, so I believe this issue can be closed.

blueyed commented 1 year ago

Closing as per previous comment.