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.
To locally check whether your long descriptions will render on PyPI, first
build your distributions, and then use the twine check
command.
You can use readme_renderer
on the command line to render an rST file as
HTML like this:
python -m readme_renderer README.rst -o /tmp/README.html
Everyone interacting in the readme_renderer project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PSF Code of Conduct.