69 lines
2.6 KiB
Plaintext
69 lines
2.6 KiB
Plaintext
|
Metadata-Version: 2.1
|
||
|
|
Name: readme-renderer
|
||
|
|
Version: 37.1
|
||
|
|
Summary: readme_renderer is a library for rendering "readme" descriptions for Warehouse
|
||
|
|
Home-page: https://github.com/pypa/readme_renderer
|
||
|
|
Author: The Python Packaging Authority
|
||
|
|
Author-email: admin@mail.pypi.org
|
||
|
|
License: Apache License, Version 2.0
|
||
|
|
Classifier: Intended Audience :: Developers
|
||
|
|
Classifier: License :: OSI Approved :: Apache Software License
|
||
|
|
Classifier: Natural Language :: English
|
||
|
|
Classifier: Operating System :: MacOS :: MacOS X
|
||
|
|
Classifier: Operating System :: POSIX
|
||
|
|
Classifier: Operating System :: POSIX :: BSD
|
||
|
|
Classifier: Operating System :: POSIX :: Linux
|
||
|
|
Classifier: Operating System :: Microsoft :: Windows
|
||
|
|
Classifier: Programming Language :: Python
|
||
|
|
Classifier: Programming Language :: Python :: 3
|
||
|
|
Classifier: Programming Language :: Python :: 3 :: Only
|
||
|
|
Classifier: Programming Language :: Python :: 3.7
|
||
|
|
Classifier: Programming Language :: Python :: 3.8
|
||
|
|
Classifier: Programming Language :: Python :: 3.9
|
||
|
|
Classifier: Programming Language :: Python :: 3.10
|
||
|
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
||
|
|
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
||
|
|
Classifier: Typing :: Typed
|
||
|
|
Requires-Python: >=3.7
|
||
|
|
License-File: LICENSE
|
||
|
|
Requires-Dist: bleach (>=2.1.0)
|
||
|
|
Requires-Dist: docutils (>=0.13.1)
|
||
|
|
Requires-Dist: Pygments (>=2.5.1)
|
||
|
|
Provides-Extra: md
|
||
|
|
Requires-Dist: cmarkgfm (>=0.8.0) ; extra == 'md'
|
||
|
|
|
||
|
|
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
|