软件规范

本文介绍了一个项目的目录结构设计原则,包括提高可读性和可维护性的方法。详细解释了必备目录的作用,例如requirements用于安装依赖,README提供软件介绍及使用指南,setup.py作为项目安装工具。此外还介绍了不同环境下的配置文件设置。

设计目录结构目的

  1. 可读性高
  2. 可维护性高

目录组织方式

  1. 必备具备的目录:

requirements

根据requirements.txt文件安装相关依赖软件

pip install  -r requirements.txt

#创建requirements文件

pip freeze > requirements.txt

README内容

  1. 软件定位,基本功能
  2. 运行代码方法:环境,启动命令
  3. 简单使用说明
  4. 代码目录结构说明,以及简洁基本原理
  5. 常见问题

setup.py

一个项目一定要有一个安装项目工具

配置文件

  1. 与平台相关性配置
  2. 配置语言
  3. 配置时区
  4. 数据库配置
  5. 日志
  6. 一般建议多个配置文件,针对不同环境,如测试,正式上线等,项目启动时自动判断settings.py,dev_setting.py,local_setting.py,prod_setting.py,unittest_setting.py

转载于:https://www.cnblogs.com/yaya625202/p/8683896.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值