readme-renderer 18.1

readme_renderer is a library for rendering "readme" descriptions for Warehouse

Readme Renderer is a library that will safely render arbitrary README files into HTML. It is designed to be used in Warehouse to render the long_description for packages. It can handle Markdown, reStructuredText (.rst), and plain text.

Check Description Locally

To check your long descriptions locally simply install the readme_renderer library using:

$ pip install readme_renderer
$ python setup.py check -r -s
running check

If there’s a problem rendering your long_description, the check will tell you. If your long_description is fine, you’ll get no output.

Code of Conduct

Everyone interacting in the readme_renderer project’s codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.