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.
4 maintainers
Release files for readme-renderer 17.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| readme_renderer-17.4.tar.gz | 18.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| readme_renderer-17.4-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 30.1 kB
Release files / readme_renderer-17.4.tar.gz
| Download URL | readme_renderer-17.4.tar.gz |
|---|---|
| Size | 18.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
82d68175feec897af2a38fe8590778f14c3be5324cc62e3ce5752a9b1e4b60ab
|
|
BLAKE2b-256 checksum How to use checksums |
e4c83e14cc98fb849a549147b18b027e40dd223115284c8b6fd0f667b95f96b1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / readme_renderer-17.4-py2.py3-none-any.whl
| Download URL | readme_renderer-17.4-py2.py3-none-any.whl |
|---|---|
| Size | 11.2 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
1fe5e7995af456dc2908a468622e8333a19ad013330a5c06b11b3bb2b685e2f5
|
|
BLAKE2b-256 checksum How to use checksums |
c9fbbc29a356e75fa45bf709405f7435b9dedb12895d2738d393bf154d0ac418
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
