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.

Render rST Description Locally

You can use readme_renderer on the command line to render an rST file as HTML like this:

python -m readme_renderer README.rst -o /tmp/README.html

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

Uploaded Source

Built Distribution

readme_renderer-33.0-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readme_renderer-33.0.tar.gz
  • Upload date:
  • Size: 29.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.0.1 pkginfo/1.5.0.1 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for readme_renderer-33.0.tar.gz
Algorithm Hash digest
SHA256 e3b53bc84bd6af054e4cc1fe3567dc1ae19f554134221043a3f8c674e22209db
MD5 1275d47730e12dd440acd8d161ed92bc
BLAKE2b-256 17dcdf354d98bf99652bfda3e6458389b35d6ae76243363cd54efc6579fff32c

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: readme_renderer-33.0-py3-none-any.whl
  • Upload date:
  • Size: 16.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.0.1 pkginfo/1.5.0.1 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for readme_renderer-33.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f02cee0c4de9636b5a62b6be50c9742427ba1b956aad1d938bfb087d0d72ccdf
MD5 2811e648b36e12133b4c41598af6cb91
BLAKE2b-256 681eee358efd562a85be55fe2bc5c9fc2996fd62d68fd10bee0ff6727a2ea257

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