Как файл README.md может быть включен в пакет модуля PyPI с помощью setup.py?

Question

Я хочу включить файл README.md с моим пакетом модулей для PyPI, чтобы его можно было прочитать функцией в моем setup.py. Однако мне не очевидно, как получить setup.py и соответствующую инфраструктуру, чтобы фактически включить файл README.md.

Я включил MANIFEST.in файл в моем пакете, который сам перечисляет README.md и я поставил setuptools.setup аргумент include_package_data в True, но это не сработало.

manifest.in:

junkmodule.py 
junkmodule_script.py 
LICENSE 
MANIFEST.in 
README.md 
setup.py 

setup.py:

#!/usr/bin/python 
# -*- coding: utf-8 -*- 

import os 
import pypandoc 
import setuptools 

def main(): 

    setuptools.setup(
     name     = "junkmodule", 
     version    = "2017.01.13.1416", 
     description   = "junk testing module", 
     long_description  = pypandoc.convert("README.md", "rst"), 
     url     = "https://github.com/user/junkmodule", 
     author    = "LRH", 
     author_email   = "lhr@psern.ch", 
     license    = "GPLv3", 
     include_package_data = True, 
     py_modules   = [ 
           "junkmodule" 
           ], 
     install_requires  = [ 
           "numpy" 
           ], 
     scripts    = [ 
           "junkmodule_script.py" 
           ], 
     entry_points   = """ 
      [console_scripts] 
      junkmodule = junkmodule:junkmodule 
     """ 
    ) 

if __name__ == "__main__": 
    main() 

Команды, которые я использую, чтобы зарегистрироваться и загрузить модуль в PyPI следующим образом:

python setup.py register -r https://pypi.python.org/pypi 
python setup.py sdist upload -r https://pypi.python.org/pypi 

Answer 1

Я использую это в моих модулях, попробуйте:

import pypandoc 


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