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
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for readme_renderer-17.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1fe5e7995af456dc2908a468622e8333a19ad013330a5c06b11b3bb2b685e2f5 |
|
MD5 | 2633c38d1e3f1a9e32fee6fc92ada1d2 |
|
BLAKE2b-256 | c9fbbc29a356e75fa45bf709405f7435b9dedb12895d2738d393bf154d0ac418 |