You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
64 lines
2.3 KiB
64 lines
2.3 KiB
Metadata-Version: 2.1
|
|
Name: readme-renderer
|
|
Version: 24.0
|
|
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
|
|
Platform: UNKNOWN
|
|
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 :: 2
|
|
Classifier: Programming Language :: Python :: 2.7
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.4
|
|
Classifier: Programming Language :: Python :: 3.5
|
|
Classifier: Programming Language :: Python :: 3.6
|
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
|
Requires-Dist: bleach (>=2.1.0)
|
|
Requires-Dist: docutils (>=0.13.1)
|
|
Requires-Dist: Pygments
|
|
Requires-Dist: six
|
|
Provides-Extra: md
|
|
Requires-Dist: cmarkgfm (>=0.2.0); extra == 'md'
|
|
|
|
Readme Renderer
|
|
===============
|
|
|
|
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 `PyPA Code of Conduct`_.
|
|
|
|
|
|
.. |twine check| replace:: ``twine check``
|
|
.. _twine check: https://packaging.python.org/guides/making-a-pypi-friendly-readme#validating-restructuredtext-markup
|
|
.. _PyPA Code of Conduct: https://www.pypa.io/en/latest/code-of-conduct/
|
|
|
|
|