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

Uploaded Source

Built Distribution

readme_renderer-23.0-py2.py3-none-any.whl (15.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: readme_renderer-23.0.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.2 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.7.0

File hashes

Hashes for readme_renderer-23.0.tar.gz
Algorithm Hash digest
SHA256 219a02f5359b6631f5ab952f6906c6c105bdd8bc4bf19c1ec5ee8bd9ea2dc1eb
MD5 565b17bf8e97808d49719e4b1cd9716d
BLAKE2b-256 f1b7042fe6b4e10ff61077465e729f1f91a024e80461d36dff9149147f796728

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: readme_renderer-23.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 15.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.2 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.7.0

File hashes

Hashes for readme_renderer-23.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f8f122ad9fd6d138337531379575a01a0b6ca70aedca78f094cb833da38c8c0c
MD5 7d1477a1eb1d734973611bb4d473d087
BLAKE2b-256 d65efc8af37e5de0d1e69edcf1e914214b4d471d262f8663bd55eb37b7b1b138

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