Python基础之软件目录结构规范

设计一个层次清晰的目录结构，就是为了达到这两点：

可读性高：不熟悉项目的人，一眼就能看懂目录结构。

可维护性高：随着时间的推移，代码/配置的规模增加，项目结构不会混乱，仍然能够组织良好。

目录组织方式：

ATM
├── bin
│ └── start.py
├── conf
│ └── settings.py
├── core
│ └── test_main.py
├── db
│ └── db.json
├── docs
├── lib
│ └── common.py
├── log
│ └── access.log
└── README

简单解释一下：

bin ：存放项目的一些可执行文件，当然你可以起名script/之类的也行。

conf ：配置文件目录

core：核心代码目录

db：数据目录

docs ：存放一些说明文档。

lib：库文件，存放一些自定义模块和包

log：日志目录

README 安装说明

关于README的内容：

README的作用是描述该项目的信息，让读者快速了解这个项目。
它需要说明以下几个事项：

软件定位，软件的基本功能。

运行代码的方法：安装环境、启动命令等。

简要的使用说明。

代码目录结构说明，更详细点可以说明软件的基本原理。

常见问题说明。

关于requirements.txt和setup.py

1、配置文件写在一个或多个python文件中，比如此处的conf.py。
2、项目中哪个模块用到这个配置文件就直接通过import conf这种形式来在代码中使用配置。
这种做法我不太赞同:
1、这让单元测试变得困难（因为模块内部依赖了外部配置）
2、另一方面配置文件作为用户控制程序的接口，应当可以由用户自由指定该文件的路径。
3、程序组件可复用性太差，因为这种贯穿所有模块的代码硬编码方式，使得大部分模块都依赖conf.py这个文件。
所以，我认为配置的使用，更好的方式是，
1、模块的配置都是可以灵活配置的，不受外部配置文件的影响。
2、程序的配置也是可以灵活控制的。
能够佐证这个思想的是，用过nginx和mysql的同学都知道，nginx、mysql这些程序都可以自由的指定用户配置。
所以，不应当在代码中直接import conf来使用配置文件。上面目录结构中的conf.py，是给出的一个配置样例，不是在写死在程序中直接引用的配置文件。可以通过给main.py启动参数指定配置路径的方式来让程序读取配置内容。当然，这里的conf.py你可以换个类似的名字，比如settings.py。或者你也可以使用其他格式的内容来编写配置文件，比如settings.yaml之类的。

配置文件说明

关于作业：

作业必备知识：

模块导入

目录组织结构

函数

第三方模块（序列化、logging）

装饰器

使用面向过程开发（ATM程序是不经常更改得程序）

软件开发流程：

画流程图

写README

严格按照软件开发规范去开发程序

作业需求：

模拟实现一个ATM + 购物商城程序

额度 15000或自定义

实现购物商城，买东西加入 购物车，调用信用卡接口结账

可以提现，手续费5%

每月22号出账单，每月10号为还款日，过期未还，按欠款总额 万分之5 每日计息

支持多账户登录

支持账户间转账

记录每月日常消费流水

提供还款接口

ATM记录操作日志

提供管理接口，包括添加账户、用户额度，冻结账户等。。。

用户认证用装饰器

示例代码 https://github.com/triaquae/py3_training/tree/master/atm　
简易流程图：https://www.processon.com/view/link/589eb841e4b0999184934329

参考链接：http://www.cnblogs.com/alex3714/articles/5765046.html