https://github.com/msabramo/setuptools-markdown

Use Markdown for your project description
https://github.com/msabramo/setuptools-markdown

Last synced: about 1 month ago
JSON representation

Use Markdown for your project description

• Host: GitHub
• URL: https://github.com/msabramo/setuptools-markdown
• Owner: msabramo
• License: mit
• Created: 2014-12-19T05:04:22.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-05-11T04:17:42.000Z (over 2 years ago)
• Last Synced: 2024-07-20T01:33:40.720Z (about 2 months ago)
• Language: Python
• Size: 17.6 KB
• Stars: 27
• Watchers: 3
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE-MIT

Awesome Lists containing this project

• starred-awesome - setuptools-markdown - Use Markdown for your project description (Python)

README

        
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

.. 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 `__ using

`pypandoc `__ and store the

resulting reST in the ``long_description`` metadata field of your

distribution.