readme-renderer

readme_renderer is a library for rendering readme descriptions for Warehouse

37 个版本 Python >=3.10
Homepage
安装
pip install readme-renderer
poetry add readme-renderer
pipenv install readme-renderer
conda install readme-renderer
描述

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: 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 .. _CONTRIBUTING.md: https://github.com/pypa/readme_renderer/blob/main/.github/CONTRIBUTING.md

Copyright © 2014, The Python Packaging Authority.

分类
Intended Audience :: Developers Natural Language :: English Operating System :: MacOS :: MacOS X Operating System :: Microsoft :: Windows Operating System :: POSIX Operating System :: POSIX :: BSD Operating System :: POSIX :: Linux Programming Language :: Python Programming Language :: Python :: 3 Programming Language :: Python :: 3 :: Only Programming Language :: Python :: 3.10 Programming Language :: Python :: 3.11 Programming Language :: Python :: 3.12 Programming Language :: Python :: 3.13 Programming Language :: Python :: 3.14 Programming Language :: Python :: Implementation :: CPython Programming Language :: Python :: Implementation :: PyPy Typing :: Typed
版本列表
45.0 2026-06-09
44.0 2024-07-08
43.0 2024-02-26
42.0 2023-09-08
41.0 2023-08-18
40.0 2023-06-19
37.3 2022-10-31
37.2 2022-09-24
37.1 2022-09-03
37.0 2022-08-21
36.0 2022-08-06
35.0 2022-04-19
34.0 2022-03-11
33.0 2022-03-05
32.0 2021-12-13
31.0 2021-12-09
30.0 2021-09-30
29.0 2021-02-23
28.0 2020-10-20
27.0 2020-10-09
26.0 2020-04-23
25.0 2020-03-14
24.0 2018-10-27
23.0 2018-10-23
22.0 2018-09-17
21.0 2018-05-28
20.0 2018-04-13
19.0 2018-04-10
18.1 2018-04-01
18.0 2018-03-31
17.4 2018-03-16
17.3 2018-03-08
17.2 2017-03-11
17.1 2017-03-09
17.0 2017-03-08
16.0 2016-12-09
0.7.0 2016-01-04