Описание PyPI markdown не работает

As @Martijn Pieters указано, PyPi не поддерживает Markdown. Я не уверен, где я узнал следующий трюк, но вы можете использовать Pandoc и PyPandoc для преобразования файлов Markdown в RestructuredText перед загрузкой в PyPi. Для этого добавьте в свой :

try:
    import pypandoc
    long_description = pypandoc.convert('README.md', 'rst')
except(IOError, ImportError):
    long_description = open('README.md').read()

setup(
    name='blah',
    version=find_version('blah.py'),
    description='Short description',
    long_description=long_description,
)

установить Pandoc на OS X, я использовал доморощенного:

brew install pandoc

установить PyPandoc, Я Пип:

pip install pypandoc

PyPI поддерживает rst, а не markdown, как упоминалось в других ответах. Но вам не нужно pypandoc перс, просто pandoc - это хорошо. Вы можете сначала создать первый файл локально, а затем запустить setup.py чтобы загрузить пакет.

upload.sh:

#!/bin/bash
pandoc --from=markdown --to=rst --output=README README.md
python setup.py sdist upload

сгенерированный файл с именем README будет автоматически распознан. Обязательно добавьте его в свой .gitignore! The setup.py ничего не нужно делать специальный.

setup.py:

from distutils.core import setup

setup(
    name='mypackage',
    packages=['mypackage'],  # this must be the same as the name above
    version='0.2.8',
    description='short',
    author='Chiel ten Brinke',
    author_email='<email>',
    url='<github url>',  # use the URL to the github repo
    keywords=[],  # arbitrary keywords
    classifiers=[],
)

тогда просто запустите bash upload.sh чтобы загрузить материал в PyPI.

у меня были проблемы с \r символы, вызывающие проблемы синтаксического анализа, где только первая строка README появляется в pypi. Код ниже устраняет проблему, он исходит из pypandoc репозитории модуля:

try:
    long_description = pypandoc.convert('README.md', 'rst')
    long_description = long_description.replace("\r","") # Do not forget this line
except OSError:
    print("Pandoc not found. Long_description conversion failure.")
    import io
    # pandoc is not installed, fallback to using raw contents
    with io.open('README.md', encoding="utf-8") as f:
        long_description = f.read()

таким образом long_description содержит дезинфицированную версию вашего Readme, и вы можете передать его в функцию setup () в вашем setup.py сценарий.

есть хороший пакет pip, который работал для меня

https://pypi.python.org/pypi/restructuredtext_lint/

Я использую его в своей настройке сейчас:

https://github.com/pablodav/burp_server_reports/blob/master/setup.py

def check_readme(file='README.rst'):
"""
Checks readme rst file, to ensure it will upload to pypi and be formatted correctly.
:param file:
:return:
"""
errors = rst_lint.lint_file(file)
if errors:
    msg = 'There are errors in {}, errors \n {}'.format(file, errors[0].message)
    raise SystemExit(msg)
else:
    msg = 'No errors in {}'.format(file)
print(msg)

также я создал lib, чтобы иметь возможность использовать в py.тест позже

https://github.com/pablodav/burp_server_reports/blob/master/burp_reports/lib/check_readme.py

выполнить эти три команды и он будет работать

pip install --upgrade setuptools
pip install --upgrade twine
pip install --upgrade wheel