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 locally check whether your long descriptions will render on PyPI, first build your distributions, and then use the twine check command.
Render rST Description Locally
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
Code of Conduct
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.
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-36.0.tar.gz.
File metadata
- Download URL: readme_renderer-36.0.tar.gz
- Upload date:
- Size: 28.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f71aeef9a588fcbed1f4cc001ba611370e94a0cd27c75b1140537618ec78f0a2 |
|
| MD5 | b1559147c5533970b8c2b3872bf5a4f7 |
|
| BLAKE2b-256 | 154e0ffa80eb3e0d0fcc0c6b901b36d4faa11c47d10b9a066fdd42f24c7e646a |
Provenance
File details
Details for the file readme_renderer-36.0-py3-none-any.whl.
File metadata
- Download URL: readme_renderer-36.0-py3-none-any.whl
- Upload date:
- Size: 14.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2c37e472ca96755caba6cc58bcbf673a5574bc033385a2ac91d85dfef2799876 |
|
| MD5 | 0a2bb469483a583596927498828223ed |
|
| BLAKE2b-256 | 0a3ece07c86adbc46cfedf637dd77333184bcd0a913f9c169b0b3afc25f67b6b |
