说明

一个好的项目目录结构看起来整洁, 大方, 能够让人赏心悦目, 让我们在开发项目中更加得心应手, 并让程序具有更高的可读性.
python作为一门编程语言, 并没有明确规定项目目录结构. 很多年前, 在 Stack Overflow 上就有人提出了这个问题 “What is the best project structure for a Python application?” (Python应用程序的最佳项目结构是什么?)
这里我参考了大佬们的回答, 再加上自己的体会得出一个自己的结论(才学疏浅, 仅供参考).

目录结构

如果你开发的项目名称为 myProject, 项目的目录结构应该如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
MyProject/
bin/
myproject/
myproject/
__init__.py
main.py
tests/
__init__.py
test_main.py
docs/
conf.py
setup.py
README.md
requirements.txt
LICENSE.txt
  • bin/: 存放脚本, 执行文件等.
  • myproject/: 存放工程源码.
  • myproject/tests/: 存放测试代码.
  • docs: 存放文档和配置.
  • setup.py:安装, 部署, 打包项目的脚本.
  • README.md: 项目说明文档
  • requiremens.txt: 存放外部依赖包列表.
  • LICENSE.txt: 项目许可声明.

参考文献

  1. What is the best project structure for a Python application? - Stack Overflow