一个好的Python项目除了代码写的好,也离不开条理清晰的目录结构。
当我们准备开源自己开发的项目,放到GitHub上供其他人下载研究的时候;
当我们的项目是团队合作,经常会有其他人员加入一起开发的时候;
条例清晰,遵循一定标准规则的项目目录结构就显的非常重要了,下面是python开源项目通常的
目录结构及说明,仅供参考:
Python通用目录结构
ProjectName
│ readme 项目说明文档
│ requirements.txt 存放依赖的外部Python包列表
│ setup.py 安装、部署、打包的脚本
├─ bin 存放脚本,执行文件等
│ └─ projectname
├─ docs 文档和配置
│ └─ abc.rst
│ └─ conf.py 配置文件
└─ projectname 工程源码(包括源码、测试代码等)
│ main.py 程序入口
│ init.py
└─ tests 测试代码
└─ test_main.py
└─ init.py