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.

Contributing

Contributions are welcome. See CONTRIBUTING.md for setup and testing.

Copyright © 2014, The Python Packaging Authority.

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: readme_renderer-45.0.tar.gz
  • Upload date:
  • Size: 36.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for readme_renderer-45.0.tar.gz
Algorithm Hash digest
SHA256 030a8fac74904f8fba11ad1bb6964e3f76e896dc7e5e71f16af190c9056696d1
MD5 87cde515314a1b60e7f6874ad7ee1946
BLAKE2b-256 0251d3a6ea424652c60f05600d8c2e01a55c913755e7cdad64afabbd1aa16f44

See more details on using hashes here.

Provenance

The following attestation bundles were made for readme_renderer-45.0.tar.gz:

Publisher: release.yml on pypa/readme_renderer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: readme_renderer-45.0-py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for readme_renderer-45.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3385ed220117104a2bceb4a9dac8c5fdf6d1f96890d7ea2a9c7174fd5c84091f
MD5 3ef0a3d6e4037155237a4c5d3086581b
BLAKE2b-256 971b295bf2fa3e740131778065e5ffa2c481f0e7210182d408e9a2c244ff5b0c

See more details on using hashes here.

Provenance

The following attestation bundles were made for readme_renderer-45.0-py3-none-any.whl:

Publisher: release.yml on pypa/readme_renderer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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