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-40.0.tar.gz (32.3 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-40.0-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readme_renderer-40.0.tar.gz
  • Upload date:
  • Size: 32.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for readme_renderer-40.0.tar.gz
Algorithm Hash digest
SHA256 9f77b519d96d03d7d7dce44977ba543090a14397c4f60de5b6eb5b8048110aa4
MD5 693dd4512f24347f0c7507e0ba5bfb07
BLAKE2b-256 22ec12a48255bb1f15e2bd16a75e9f537ea498c8884069de4655afe47d5ffe34

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readme_renderer-40.0-py3-none-any.whl
  • Upload date:
  • Size: 14.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for readme_renderer-40.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e18feb2a1e7706f2865b81ebb460056d93fb29d69daa10b223c00faa7bd9a00a
MD5 2cd9823d3ce77ae4806aae053022117f
BLAKE2b-256 29a9200b7f2397bc9f9d1653cfffa14bd57d38982317d58deac11520b7163f5c

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