readme-renderer 44.0


pip install readme-renderer

  Latest version

Released: Jul 08, 2024

Project Links

Meta
Author: The Python Packaging Authority
Requires Python: >=3.9

Classifiers

Intended Audience
  • Developers

License
  • OSI Approved :: Apache Software License

Natural Language
  • English

Operating System
  • MacOS :: MacOS X
  • POSIX
  • POSIX :: BSD
  • POSIX :: Linux
  • Microsoft :: Windows

Programming Language
  • Python
  • Python :: 3
  • Python :: 3 :: Only
  • Python :: 3.9
  • Python :: 3.10
  • Python :: 3.11
  • Python :: 3.12
  • Python :: Implementation :: CPython
  • Python :: Implementation :: PyPy

Typing
  • Typed
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.

Copyright © 2014, [The Python Packaging Authority].

Wheel compatibility matrix

Platform Python 3
any

Files in release

Extras:
Dependencies:
nh3 (>=0.2.14)
docutils (>=0.21.2)
Pygments (>=2.5.1)