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 这种形式在代码中使用
  • 8
    点赞
  • 42
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值