day4-软件目录开发规范

软件目录开发规范

1、目录结构

假设你的项目名是atm，我比较建议的最方便快捷目录结构这样就足够了：

Foo/
|-- bin/
|   |-- foo
|
|-- foo/
|   |-- tests/
|   |   |-- __init__.py
|   |   |-- test_main.py
|   |
|   |-- __init__.py
|   |-- main.py
|
|--conf/
|  |-- __init__.py
|　|-- settings.py
|
|--logs/
|
|-- docs/
|   |-- conf.py
|   |-- abc.rst
|
|-- setup.py
|-- requirements.txt
|-- README

简单解释一下：

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

foo/: 存放项目的所有源代码

(1) 源代码中的所有模块、包都应该放在此目录，不要置于顶层目录

(2) 其子目录tests/存放单元测试代码

(3) 程序的入口最好命名为main.py

conf/: 存放项目的一些配置文件

logs/: 存放项目执行的日志信息

docs/: 存放一些文档

setup.py: 安装、部署、打包的脚本

requirements.txt: 存放软件依赖的外部Python包列表

README: 项目说明文件

2. README

文件最好有一下说明：

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

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

简要的使用说明

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

常见问题说明