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-26.0.tar.gz (27.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-26.0-py2.py3-none-any.whl (15.6 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: readme_renderer-26.0.tar.gz
  • Upload date:
  • Size: 27.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for readme_renderer-26.0.tar.gz
Algorithm Hash digest
SHA256 cbe9db71defedd2428a1589cdc545f9bd98e59297449f69d721ef8f1cfced68d
MD5 cd03f91949e740c906f946a4d20d5d7d
BLAKE2b-256 13d68e241e4e40404a1f83567d6a29798abee0b9b50b08c8efc815ce11c41df9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readme_renderer-26.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 15.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for readme_renderer-26.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cc4957a803106e820d05d14f71033092537a22daa4f406dfbdd61177e0936376
MD5 f4b743aa79f317b3e7cac29531b243d7
BLAKE2b-256 54e4ed43056d80a4fcc3667e543a59cc6beaf0a3c0eade837e5591e82ad3c25a

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