阅读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和旧的分发文档中，所以很难弄清楚你需要做什么。