Skip to main content

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.

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.

Project details


Download files

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

Source Distribution

readme_renderer-24.0.tar.gz (24.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

readme_renderer-24.0-py2.py3-none-any.whl (15.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file readme_renderer-24.0.tar.gz.

File metadata

  • Download URL: readme_renderer-24.0.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.2 pkginfo/1.4.2 requests/2.19.1 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.7.0

File hashes

Hashes for readme_renderer-24.0.tar.gz
Algorithm Hash digest
SHA256 bb16f55b259f27f75f640acf5e00cf897845a8b3e4731b5c1a436e4b8529202f
MD5 8c9a2cef4f9a6455e4a1f8a87b3f7bf1
BLAKE2b-256 44dea567140b13a0fc8d3b04d85a510b5a7d9869b44b2939fa8ac07c5e421485

See more details on using hashes here.

File details

Details for the file readme_renderer-24.0-py2.py3-none-any.whl.

File metadata

  • Download URL: readme_renderer-24.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 15.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.2 pkginfo/1.4.2 requests/2.19.1 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.7.0

File hashes

Hashes for readme_renderer-24.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c8532b79afc0375a85f10433eca157d6b50f7d6990f337fa498c96cd4bfc203d
MD5 4e99feff12b8d3f02ca2c0794cee9ffc
BLAKE2b-256 c37ed1aae793900f36b097cbfcc5e70eef82b5b56423a6c52a36dce51fedd8f0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page