https://github.com/pypa/readme_renderer
Safely render long_description/README files in Warehouse
https://github.com/pypa/readme_renderer
Last synced: 13 days ago
JSON representation
Safely render long_description/README files in Warehouse
- Host: GitHub
- URL: https://github.com/pypa/readme_renderer
- Owner: pypa
- License: apache-2.0
- Created: 2014-02-27T18:21:19.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2025-01-18T11:30:04.000Z (5 months ago)
- Last Synced: 2025-06-08T16:53:08.979Z (23 days ago)
- Language: Python
- Homepage:
- Size: 308 KB
- Stars: 164
- Watchers: 16
- Forks: 92
- Open Issues: 23
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
- starred-awesome - readme_renderer - Safely render long_description/README files in Warehouse (Python)
README
Readme Renderer
===============
.. image:: https://badge.fury.io/py/readme-renderer.svg
:target: https://badge.fury.io/py/readme-renderer
.. image:: https://github.com/pypa/readme_renderer/actions/workflows/ci.yml/badge.svg
:target: https://github.com/pypa/readme_renderer/actions/workflows/ci.yml
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: https://github.com/pypa/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: https://packaging.python.org/guides/making-a-pypi-friendly-readme#validating-restructuredtext-markup
.. _PSF Code of Conduct: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md
Copyright © 2014, [The Python Packaging Authority].