setuptools-markdown

0.4.1 verified Fri May 01 auth: no python deprecated

Deprecated library that allowed using Markdown for project descriptions in setuptools. Version 0.4.1 is the last release. It has been replaced by built-in support in setuptools (>=38.6.0) via setup.cfg or pyproject.toml.

pip install setuptools-markdown

Common errors

error ImportError: No module named setuptools_markdown ↓

cause Attempting to import the library as a module.

fix

Do not import setuptools_markdown. It is a setuptools plugin installed via entry points.

error error in setup command: 'long_description_content_type' is an invalid keyword argument for this function ↓

cause Using an older version of setuptools that does not support long_description_content_type.

fix

Upgrade setuptools: pip install --upgrade setuptools>=38.6.0

error Unknown markdown flavor: markdown ↓

cause Using setuptools-markdown with an unsupported flavor (only 'markdown' or the default). The library expects 'markdown' but setuptools may produce this error.

fix

Use setuptools >=38.6.0 and set long_description_content_type='text/markdown' instead.

Warnings

deprecated setuptools-markdown has been deprecated. Use setuptools >=38.6.0 built-in Markdown support. ↓

fix Remove setuptools-markdown dependency and set long_description_content_type='text/markdown' in setup.py, or use setup.cfg/pyproject.toml.

gotcha Do not import setuptools_markdown anywhere in your code. It is automatically discovered via entry points. ↓

fix Remove any 'import setuptools_markdown' statements.

breaking Does not support Python 3. The final release only supports Python 2. ↓

fix Upgrade to Python 3 and use setuptools' built-in support.

Imports

setup
wrong
```
import setuptools_markdown
```
correct
```
from setuptools import setup
```
No import needed; it's used via setup() or setup.cfg. Do not import the library.

Quickstart

Modern way: use setuptools directly with long_description_content_type. No need for setuptools-markdown.

from setuptools import setup

setup(
    name='my-package',
    long_description='**Markdown** content',
    long_description_content_type='text/markdown',
)