readme-renderer (37.0)

Published 2022-08-26 17:51:49 +02:00 by guillem


pip install --index-url  readme-renderer

About this package

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

Readme Renderer

.. image:: :target:

.. image:: :target:

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.

.. _Warehouse:

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_.

.. |twine check| replace:: twine check .. _twine check: .. _PSF Code of Conduct:


Requires Python: >=3.7
2022-08-26 17:51:49 +02:00
The Python Packaging Authority
Apache License, Version 2.0
14 KiB
Assets (1)
Versions (1) View all
37.0 2022-08-26