Python模块组织的最佳实践是什么？

这是一个展示如何很好地组织项目结构的示例项目： https://github.com/kennethreitz/samplemod. 该项目目的是创建 “sample” 模块。目录结构如下所示：

README.rst
LICENSE
setup.py
requirements.txt
sample/__init__.py
sample/core.py
sample/helpers.py
docs/conf.py
docs/index.rst
tests/test_basic.py
tests/test_advanced.py

README.rst 文件： 此文件用于简要描述模块的内容、如何设置、如何使用等。

LICENSE： 包含许可证文本和任何版权声明。

setup.py： 它是 Python 跨平台安装程序的答案，也是一个 make 文件。如果您熟悉命令行安装，则 make & & make install 可以翻译为 python setup.py build & & python setup.py install。因此，它用于在用户机器上构建项目。

requirements.txt： Pip 要求文件应指定投稿到项目所需的依赖项：测试、构建和生成文档。如果项目没有开发依赖项，或者您喜欢通过 setup.py 进行开发环境设置，则此文件是不必要的。

docs/： 此目录包含项目的文档。

tests/： 所有测试应该放在此目录中。最初您将有一个单独的测试文件。随着它们的增长，您可以像您的模块目录一样结构化您的测试。

sample/： 此目录包含您的实际模块代码。如果您的模块只包含一个文件，则可以将其直接放在存储库的根目录下作为 sample.py。您的库不应属于一个模棱两可的 src 或 python 子目录。如果您想让此模块属于某个包，则会包含一个 init.py 文件。

更多Python相关文章，请阅读：Python 教程