Skip to main content

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

Project description

https://badge.fury.io/py/readme-renderer.svg https://github.com/pypa/readme_renderer/actions/workflows/ci.yml/badge.svg

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 PSF 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-37.2.tar.gz (29.5 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-37.2-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readme_renderer-37.2.tar.gz
  • Upload date:
  • Size: 29.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for readme_renderer-37.2.tar.gz
Algorithm Hash digest
SHA256 e8ad25293c98f781dbc2c5a36a309929390009f902f99e1798c761aaf04a7923
MD5 d4f8f00cea308d9da6c0f6d5335b4d5d
BLAKE2b-256 236492a624415197aa5a9a28196f44c2cf44230a362ec2b98c7d5d60a7322580

See more details on using hashes here.

File details

Details for the file readme_renderer-37.2-py3-none-any.whl.

File metadata

  • Download URL: readme_renderer-37.2-py3-none-any.whl
  • Upload date:
  • Size: 14.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for readme_renderer-37.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d3f06a69e8c40fca9ab3174eca48f96d9771eddb43517b17d96583418427b106
MD5 e13b2ca25987eec3d54104ecd70f75c4
BLAKE2b-256 20ca888ac82ed1ddb7cfd91a9d61d2f884ee3a5f34ef1b2a87c63d19f32ec564

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