Metadata-Version: 2.0
Name: readme-renderer
Version: 16.0
Summary: readme_renderer is a library for rendering "readme" descriptions for Warehouse
Home-page: https://github.com/pypa/readme_renderer
Author: Donald Stufft
Author-email: donald@stufft.io
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.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Dist: Pygments
Requires-Dist: bleach
Requires-Dist: docutils (>=0.13.1)
Requires-Dist: six

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.

.. _Warehouse: https://github.com/pypa/warehouse


Check Description Locally
-------------------------

To check your long description's locally simply install the readme_renderer
library using:

.. code-block:: console

    $ pip install readme_renderer
    $ python setup.py check -r -s


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

.. _PyPA Code of Conduct: https://www.pypa.io/en/latest/code-of-conduct/


