Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.19 KB

README.rst

File metadata and controls

55 lines (36 loc) · 1.19 KB

setuptools-markdown

Use Markdown for your project description


This project is deprecated.

Instead of using this, you should use the built-in functionality of setuptools and PyPI.

See this page for details.


Install

  1. Install pandoc
  2. Install this module
pip install setuptools-markdown

Use

#!/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 using pypandoc and store the resulting reST in the long_description metadata field of your distribution.