阅读setup.py中的README文件

Question

所以,我希望long_description我的安装脚本是我README.md文件中的内容.但是当我这样做时,源代码分发的安装将失败,因为python setup.py sdist不会复制自述文件.

有没有办法让命令distutils.core.setup()包含README.md文件,sdist以便安装不会失败？

我已经尝试了一些解决方法,当README.md文件不可用时,我默认使用一些较短的文本,但实际上我确实希望不仅PyPi获取自述文件的内容,而且还有安装包的用户.

Answer 1

要手动在分发中包含文件,请执行以下操作:

1. 组 include_package_data = True

2. 创建一个MANIFEST.in文件,其中include <glob>包含要从项目根目录中包含的每个文件的行列表.您可以使用recursive-include <dirname> <glob>从项目根目录的子目录中包含.

不幸的是,这些东西的文档非常碎片化,并且分散在Python distutils,setuptools和旧的分发文档中,因此很难弄清楚你需要做什么.