Python开发规范及文件命名

Python开发规范

---

常用目录

目录名	作用
log	日志目录
conf	配置目录
core	核心代码
libs/modules	第三方库
docs	文档库
README	帮助文档
bin	启动入口,存放可执行文件
tests	存放测试代码

常用的文件命名

目录名	作用
main.py	主逻辑
setup.py	安装程序打包部署 setuptools 百度就有教程
requirements.txt	插件及目录版本控制 pip freeze 直接打印应用的包
README.md	帮助文档

README说明文档结构

• [x] 1.软件定位，软件的基本功能
• [x] 2.运行代码方法：安装环境、启动命令等
• [x] 3.简要使用说明
• [x] 4.代码目录结构说明
• [x] 5.常见问题说明

conf.py 配置文档

• 项目中哪个模块用到这个配置文件直接通过import conf 这种形式在代码中使用