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

Uploaded Source

Built Distribution

readme_renderer-41.0-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for readme_renderer-41.0.tar.gz
Algorithm Hash digest
SHA256 4f4b11e5893f5a5d725f592c5a343e0dc74f5f273cb3dcf8c42d9703a27073f7
MD5 088fa2e0c638a34de6dbfc2467eec4e2
BLAKE2b-256 163fab83435572c1a3b1a8a6f9bdfc2b5a24dc642583c7c06ceee63a84cfd104

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for readme_renderer-41.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a38243d5b6741b700a850026e62da4bd739edc7422071e95fd5c4bb60171df86
MD5 ee75efd6cafde757d969ed07d68d48ab
BLAKE2b-256 b5a299fbffc358c2d19700d3a4a038fa451e7ac6a4067a16df4588d068f841e2

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