---
id: readme-renderer
version: "45.0"
license: Apache-2.0
license_treatment: permissive
maintenance: active
---

# readme-renderer — readme_renderer is a library for rendering readme descriptions for Warehouse

License: permissive · Maintenance: active · Popularity: top 1,000 on PyPI

## Install

pip install readme-renderer
uv add readme-renderer
poetry add readme-renderer

## Description

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


Contributing
------------
Contributions are welcome. See `CONTRIBUTING.md`_ for setup and testing.


.. |twine check| replace:: ``twine check``
.. _twine check:...

## AI interpretation — verify before relying

Safely renders README files in Markdown, reStructuredText, and plain text into HTML, designed for PyPI package documentation display.

Verdict: Stable, actively maintained library with no known vulnerabilities and permissive licensing. Low install friction and broad Python version support (3.10–3.14) make it a reliable choice for rendering package documentation. Part of the official PyPA toolchain.

[View on SkillFed](https://skillfed.io/packages/readme-renderer) · [View on PyPI](https://pypi.org/project/readme-renderer/)