python项目目录结构

python 项目目录结构

目录组织方式

假设你的项目名为foo, 我比较建议的最方便快捷目录结构这样就足够了:
Foo/
|-- bin/
| |-- foo
|
|-- foo/
| |-- tests/
| | |-- init.py
| | |-- test_main.py
| |
| |-- init.py
| |-- main.py
|
|-- docs/
| |-- conf.py
| |-- abc.rst
|
|-- setup.py
|-- requirements.txt
|-- README

简要解释一下:

• bin/: 存放项目的一些可执行文件，当然你可以起名script/之类的也行。
• foo/: 存放项目的所有源代码。
  1. 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。
  2. 其子目录tests/存放单元测试代码；
  3. 程序的入口最好命名为main.py。
• docs/: 存放一些文档。如果你的项目偏机器学习类，$数据集(dataset)$，$模型文件(model)$也可以放这里面
• setup.py: 安装、部署、打包的脚本。
• requirements.txt: 存放软件依赖的外部Python包列表。
• README: 项目说明文件。
• 除此之外，有一些方案给出了更加多的内容。比如LICENSE.txt,ChangeLog.txt文件等，这些东西主要是项目开源的时候需要用到。

示例项目可以参考：

https://github.com/pentiumCM/machinelearn