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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for readme_renderer-37.0.tar.gz
Algorithm Hash digest
SHA256 07b7ea234e03e58f77cc222e206e6abb8f4c0435becce5104794ee591f9301c5
MD5 0e9084dffb405cbbe331293c355f9064
BLAKE2b-256 5ece932f615a88ab777f1424277bfdcfe9b6b686a60e5f83d896749571d8e7d9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readme_renderer-37.0-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.13

File hashes

Hashes for readme_renderer-37.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9fa416704703e509eeb900696751c908ddeb2011319d93700d8f18baff887a69
MD5 1874f6d776153f38be29cf89c290fa9b
BLAKE2b-256 025784c09c2721b00eb53cebd4cc68c7c7bf666d2f9732e80dd8d4a590aeeb90

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