python - 我应该在模块的 requirements.txt 中包含 Sphinx 和/或 Nose 吗？

Question

我在 Github 上创建了一个 Python 模块，它使用 Nose 进行单元测试，使用 Sphinx 生成文档。我有两个问题:

• 我是否应该在 setup.py (install_requires) 的模块依赖项中包含 Sphinx 和/或 Nose，因为它们不是基本模块功能所必需的，只有当您想自己构建文档/运行测试时？

• 出于同样的原因，我是否应该在 Github 上的模块的 requirements.txt 中包含 Sphinx 和/或 Nose，但从 Github 下载我的项目的用户可能更有可能构建文档/运行测试？

这是我的第一个 Python 模块，因此我将不胜感激一些最佳实践/标准建议。

Answer 1

如果您的包的基本功能不需要nose 和/或sphinx，那么不要将它们包含在setup.py 中.强制用户安装他们可能永远不会使用的软件包是没有意义的。如果他们最终想帮助您开发您的软件包，他们可以自己安装必要的软件包。

requirements.txt 文件也不应该包含开发所需的包，尽管那里有一些回旋余地。

例如，在 pandas我们使用我们的 Travis-CI 构建的需求文件。你可以去看看here .

我们正在考虑的一件事是在 Travis-CI 上构建我们的文档，因为有时失败的文档构建会捕获测试套件不会捕获的错误。在这种情况下，我们会将 sphinx 放入我们用于构建文档的 Python 版本的需求文件中。