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 checkIf 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.
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-18.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 023f11894fc61744749fbf97a53d6e843fdcba2494f891d800f7f293720e1587 |
|
| MD5 | ff786e2d8ac248fb3b399dda5ad32290 |
|
| BLAKE2b-256 | f7708d00e2abe453560893b4bfc1d752d92ea4b3edbf132fe540b5460b9c1d6c |
