阅读setup.py中的自述文件 [英] read README in setup.py

问题描述

因此，我希望安装脚本的long_description是README.md文件中的内容。但当我执行此操作时，源分发的安装将失败，因为python setup.py sdist不复制自述文件。

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

我尝试了一个小的解决方法，当README.md文件不可用时，我默认为一些较短的文本，但我实际上希望PyPI不仅获得自述文件的内容，而且还获得安装该程序包的用户。

推荐答案

若要手动将文件包括在分发中，请执行以下操作：

1. 设置include_package_data = True

2. 创建一个MANIFEST.in文件，该文件包含一个include <glob>行的列表，用于您希望从项目根目录中包括的每个文件。您可以使用recursive-include <dirname> <glob>从项目根的子目录中包含。

遗憾的是，这些内容的文档非常零散，并且分散在Python distutils、setupTools和旧的分发文档中，因此很难确定您需要做什么。

这篇关于阅读setup.py中的自述文件的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！