readme-renderer (37.0)

Published 2 years ago by guillem

Installation

To install the package using pip, run the following command:

pip install --extra-index-url https://git.guillemborrell.es/api/packages/guillem/pypi/simple readme-renderer

For more information on the PyPI registry, see the documentation.

About this package

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

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

Requirements

Requires Python: >=3.7

Details

PyPI

2 years ago

62

The Python Packaging Authority

Project Site

Apache License, Version 2.0

14 KiB

Assets (1)

readme_renderer-37.0-py3-none-any.whl 14 KiB

Versions (1) View all

37.0 on 2022-08-26