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.3.tar.gz (29.7 kB view details)

Uploaded Source

Built Distribution

readme_renderer-37.3-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for readme_renderer-37.3.tar.gz
Algorithm Hash digest
SHA256 cd653186dfc73055656f090f227f5cb22a046d7f71a841dfa305f55c9a513273
MD5 302964c57f9b0d15d1a434f31a13ab22
BLAKE2b-256 81c3d20152fcd1986117b898f66928938f329d0c91ddc47f081c58e64e0f51dc

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for readme_renderer-37.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f67a16caedfa71eef48a31b39708637a6f4664c4394801a7b0d6432d13907343
MD5 dd1546fc96c833095af0a48ef6309b8e
BLAKE2b-256 9752fd8a77d6f0a9ddeb26ed8fb334e01ac546106bf0c5b8e40dc826c5bd160f

See more details on using hashes here.

Provenance

Supported by

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