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

Uploaded Source

Built Distribution

readme_renderer-37.1-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for readme_renderer-37.1.tar.gz
Algorithm Hash digest
SHA256 96768c069729f69176f514477e57f2f8cd543fbb2cd7bad372976249fa509a0c
MD5 8467303e167b59a949165013ef3405a9
BLAKE2b-256 91ff5abdfa03c1685f785e6d5211cfdeb8e06f75a1162fcdb19e0eb69401a6cb

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for readme_renderer-37.1-py3-none-any.whl
Algorithm Hash digest
SHA256 16c914ca7731fd062a316a2a8e5434a175ee34661a608af771a60c881f528a34
MD5 0f5486680e3b88cdef920cf451400c77
BLAKE2b-256 2e7e82026464c787172b530f5194af33cc86409bebef114d6932dc452c78317d

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