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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for readme_renderer-43.0.tar.gz
Algorithm Hash digest
SHA256 1818dd28140813509eeed8d62687f7cd4f7bad90d4db586001c5dc09d4fde311
MD5 5fa2371162f5c0f5a3b8a880ae41b7be
BLAKE2b-256 feb5536c775084d239df6345dccf9b043419c7e3308bc31be4c7882196abc62e

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for readme_renderer-43.0-py3-none-any.whl
Algorithm Hash digest
SHA256 19db308d86ecd60e5affa3b2a98f017af384678c63c88e5d4556a380e674f3f9
MD5 86f6ff995c33b3e7bf1a82dc03e17ea5
BLAKE2b-256 45be3ea20dc38b9db08387cf97997a85a7d51527ea2057d71118feb0aa8afa55

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