Metadata-Version: 2.4
Name: setuptools-markdown
Version: 0.2
Summary: Use Markdown for your project description
Home-page: https://github.com/msabramo/setuptools-markdown
Author: Marc Abramowitz
Author-email: marc@marc-abramowitz.com
License: MIT
Keywords: distutils setuptools markdown
Requires-Dist: pypandoc
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: requires-dist
Dynamic: summary

setuptools-markdown
===================

Use `Markdown <http://daringfireball.net/projects/markdown/>`__ for your
project description


Install
=======

1. Install `pandoc <http://johnmacfarlane.net/pandoc/>`_

2. Install this module

.. code:: console

    pip install setuptools-markdown


Use
===

.. code:: python

    #!/usr/bin/env python
    # setup.py

    from setuptools import setup

    setup(
        ...
        setup_requires=['setuptools-markdown'],
        long_description_markdown_filename='README.md',
        ...
    )

The plugin will read the specified file, convert it to
`reST <http://en.wikipedia.org/wiki/ReStructuredText>`__ using
`pypandoc <https://pypi.python.org/pypi/pypandoc>`__ and store the
resulting reST in the ``long_description`` metadata field of your
distribution.
