如何使用 setup.py 将 README.md 文件包含在 PyPI 模块包中？答案

【问题标题】：How can a README.md file be included in a PyPI module package using setup.py?如何使用 setup.py 将 README.md 文件包含在 PyPI 模块包中？
【发布时间】：2017-05-28 23:35:10
【问题描述】：

我想在我的 PyPI 模块包中包含一个 README.md 文件，以便我的 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

【问题讨论】：

标签： setup.py pypi readme

【解决方案1】：

我在我的模块中使用这个，试试：

import pypandoc


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

【讨论】：