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 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.
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.
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
File details
Details for the file readme_renderer-21.0.tar.gz.
File metadata
- Download URL: readme_renderer-21.0.tar.gz
- Upload date:
- Size: 26.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 422404013378f0267ee128956021a47457db8eb487908b70b8a7de5fa935781a |
|
| MD5 | aa38c559c33ee349ba315c7fbe6931eb |
|
| BLAKE2b-256 | d1bde59a1e15a1d0742d34994720d0ea5c06d42c6acde8cec4a1c41188384401 |
Provenance
File details
Details for the file readme_renderer-21.0-py2.py3-none-any.whl.
File metadata
- Download URL: readme_renderer-21.0-py2.py3-none-any.whl
- Upload date:
- Size: 11.3 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4547549521518be153ec428e86c0ee7c41ebd24c26b948e1d5627c94ad470808 |
|
| MD5 | 2bcfa6e6d7178f71f5db70405fe68cb1 |
|
| BLAKE2b-256 | f1515dacc776e38f03b00105d3c1d170c8516c62d1187ffc463f7c432f56a8c4 |
