Skip to main content

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

Project description

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

reStructuredText

To locally check whether your reStructuredText long descriptions will render on PyPI, 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.

Markdown

Checking your Markdown long descriptions is unecessary, because unlike rST, where a properly rendered description is all-or-nothing, PyPI will still render your Markdown description as Markdown if it has some invalid or incorrect syntax.

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for readme-renderer, version 19.0
Filename, size File type Python version Upload date Hashes
Filename, size readme_renderer-19.0-py2.py3-none-any.whl (10.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size readme_renderer-19.0.tar.gz (20.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page