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

Uploaded Source

Built Distribution

readme_renderer-44.0-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readme_renderer-44.0.tar.gz
  • Upload date:
  • Size: 32.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for readme_renderer-44.0.tar.gz
Algorithm Hash digest
SHA256 8712034eabbfa6805cacf1402b4eeb2a73028f72d1166d6f5cb7f9c047c5d1e1
MD5 bcbb9d99a7b02379041044552f180c70
BLAKE2b-256 5aa9104ec9234c8448c4379768221ea6df01260cd6c2ce13182d4eac531c8342

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for readme_renderer-44.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2fbca89b81a08526aadf1357a8c2ae889ec05fb03f5da67f9769c9a592166151
MD5 763b3f1823a569b7bdcb4b1a8a77f8e0
BLAKE2b-256 e167921ec3024056483db83953ae8e48079ad62b92db7880013ca77632921dd0

See more details on using hashes here.

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