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.

Copyright © 2014, [The Python Packaging Authority].

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-42.0.tar.gz (31.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-42.0-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readme_renderer-42.0.tar.gz
  • Upload date:
  • Size: 31.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for readme_renderer-42.0.tar.gz
Algorithm Hash digest
SHA256 2d55489f83be4992fe4454939d1a051c33edbab778e82761d060c9fc6b308cd1
MD5 07a8116a8d7340963961bce08f5b9417
BLAKE2b-256 b5351cb5a6a97514812f63c06df6c2855d82ebed3e5c02e9d536a78669854c8a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readme_renderer-42.0-py3-none-any.whl
  • Upload date:
  • Size: 13.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for readme_renderer-42.0-py3-none-any.whl
Algorithm Hash digest
SHA256 13d039515c1f24de668e2c93f2e877b9dbe6c6c32328b90a40a49d8b2b85f36d
MD5 2d9408dfc721568d6fd5e6b10f079661
BLAKE2b-256 b57e992e0e21b37cadd668226f75fef0aa81bf21c2426c98bc06a55e514cb323

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