Skip to main content

readme is a library for rendering "readme" descriptions for Warehouse

Project description

Warning

The readme library was renamed to readme_renderer to work around an installation issue that could prevent it from being installed on some systems. Use the readme_renderer library instead.

Readme 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.

Check Description Locally

To check your long description’s locally simply install the readme library using:

$ pip install readme
$ python setup.py check -r -s

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
readme-0.7.1-py2.py3-none-any.whl (3.0 kB) Copy SHA256 hash SHA256 Wheel py2.py3
readme-0.7.1.tar.gz (5.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page