pypa / readme_renderer

Safely render long_description/README files in Warehouse
Apache License 2.0
158 stars 89 forks source link

Warning message says to install readme_render[md] but cmarkgfm must be installed #133

Closed kpinc closed 6 years ago

kpinc commented 6 years ago

This is something of an FYI because I'm not clear on what is really supposed to happen.

I tried running "twine check" and got a message that the README.rst could not be checked and that 'readme_render[md]' needed to be installed. But it seems that what needs to be installed is cmarkgfm.

The message is coming from readme_renderer. (Seemingly markdown.py line 28.)

FWIW, setup.py does not install_requires cmarkgfm either.

Thanks for listening.

di commented 6 years ago

Thanks @kpinc, I think I know what's happening here. The warning can be ignored.

kpinc commented 6 years ago

On Thu, 25 Oct 2018 14:51:11 +0000 (UTC) Dustin Ingram notifications@github.com wrote:

Thanks @kpinc, I think I know what's happening here. The warning can be ignored.

I couldn't ignore it entirely because my "twine check" was not working and the message was the only clue I had as to why not. At least I assumed it was not working.

FYI.

I had to put

deps = cmarkgfm ...

into my tox.ini in order to get twine check ... to work. Or at least to not give me the warning.

Should I not have cmarkgfm in my deps?

(I bet I started looking at replacing 'setup.py check' with 'twine check' a year or more ago, and this has been an annoyance blocking me since then. I finally decided to buckle down and figure it out.)

Regards,

Karl kop@meme.com Free Software: "You don't pay back, you pay forward." -- Robert A. Heinlein

mmerickel commented 6 years ago

Note also that it's readme_renderer[md], not readme_render[md].

I also opened https://github.com/pypa/twine/issues/420 related to its misuse of the new optional support for markdown in readme_renderer.

di commented 6 years ago

We'll fix this in twine with https://github.com/pypa/twine/pull/421.