软件目录开发规范

软件开发的目录规范

      为了提高程序的可读性与可维护性，我们应该为软件设计良好的目录结构，这与规范的编码风格同等重要。
    软件的目录规范并无硬性标准，只要清晰可读即可，假设你的软件名为foo，笔者推荐目录结构如下：

        Foo/
        |-- core/
        |   |-- core.py
        |
        |-- api/
        |   |-- api.py
        |
        |-- db/
        |   |-- db_handle.py
        |
        |-- lib/
        |   |-- common.py
        |
        |-- conf/
        |   |-- settings.py
        |
        |-- run.py
        |-- setup.py
        |-- requirements.txt
        |-- README

     • core/: 存放业务逻辑相关代码

    ​ • api/: 存放接口文件，接口主要用于为业务逻辑提供数据操作。

    ​ • db/: 存放操作数据库相关文件，主要用于与数据库交互

    ​ • lib/: 存放程序中常用的自定义模块

    ​ • conf/: 存放配置文件

    ​ • run.py: 程序的启动文件，一般放在项目的根目录下，因为在运行时会默认将运行文件所在的文件夹作为sys.path的第一个路径，这样就省去了处理环境变量的步骤

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

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

​     • README: 项目说明文件。
            1、软件定位，软件的基本功能；
            2、运行代码的方法: 安装环境、启动命令等；              
            3、简要的使用说明；                
            4、代码目录结构说明，更详细点可以说明软件的基本原理；                
            5、常见问题说明。