Skip to main content

readme_renderer is a library for rendering "readme" descriptions for Warehouse

Project description

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 PyPA 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-25.0.tar.gz (24.1 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-25.0-py2.py3-none-any.whl (15.5 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: readme_renderer-25.0.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.4

File hashes

Hashes for readme_renderer-25.0.tar.gz
Algorithm Hash digest
SHA256 e67d64242f0174a63c3b727801a2fff4c1f38ebe5d71d95ff7ece081945a6cd4
MD5 f5adb021bdefff2b77897116a152c4c4
BLAKE2b-256 d63b2dc38264c9dfe0974f44ee075672cf6ed09fc8a3c4d8e409785ca35e935e

See more details on using hashes here.

File details

Details for the file readme_renderer-25.0-py2.py3-none-any.whl.

File metadata

  • Download URL: readme_renderer-25.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 15.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.4

File hashes

Hashes for readme_renderer-25.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1b6d8dd1673a0b293766b4106af766b6eff3654605f9c4f239e65de6076bc222
MD5 157d50bfe97de4be1c14a3f2c025c510
BLAKE2b-256 ec1c1250524c071ee847732b2ba884b88db568059eea9b997f9f7b7ceb78f691

See more details on using hashes here.

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