- 目录结构
- Project项目名
- bin(script)/
存放可执行文件 - config(conf)/
配置文件 - project/
存放代码文件- lib/
存放自定义模块/包 - main.py
- lib/
- docs/
存放说明文档 - db/
数据库文件 - log/
存放日志文件 - setup.py
安装、部署、打包的脚本
业界标准的写法是用Python流行的打包工具setuptools来管理这些事情 - requirements.txt
存放软件依赖的外部Python包列表
目的
1、方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中,避免在 setup.py 安装依赖时漏掉软件包。
2、方便读者明确项目使用了哪些Python包 - tests/
单元测试代码 - README
项目说明文件
目的是能简要描述该项目的信息,让读者快速了解这个项目
需要说明以下几个事项:
软件定位,软件的基本功能。
运行代码的方法: 安装环境、启动命令等。
简要的使用说明。
代码目录结构说明,更详细点可以说明软件的基本原理。
常见问题说明。
例子https://github.com/pallets/flask/blob/master/README.rst - LICENSE.txt
- ChangeLog.txt
- bin(script)/
- Project项目名
- 参考文档
- 【Python】Python 项目目录结构阿健的博客-CSDN博客python项目文件夹
- Python的项目代码结构 - 云+社区 - 腾讯云 (tencent.com)