Skip to main content

[Deprecated] Use Markdown for your project description

Project description

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.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page