Python软件目录结构规范

By Liu Xiaowan

目录结构如图所示

Python软件目录结构规范

目录结构简介

bin/

存放项目的一些可执行文件

analysisfiles/

存放项目的所有源代码。此目录也可以用其他名字命名。

  • 源代码中的所有模块,包都应该放在此目录。不要置于顶层目录;

analysisfiles/tests/

  • 存放单元测试代码;
  • 程序入口main.py

docs/

存放一些文档

setup.py

安装、部署、打包的脚本。

  • 可以使用打包工具setuptools来管理。

requirements.txt

存放软件以来的外部Python包列表。

  • 方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中,避免在setup.py安装依赖时漏掉软件包。
  • 方便读者明确项目使用了哪些Python包。
  • 格式说明
    • 每一行包含一个包依赖的说明;例如:flask>=0.10

README.md

项目说明文件

README的内容

  • 软件定位,软件的基本功能;
  • 运行代码的方法:安装环境、启动命令等;
  • 简要的使用说明;
  • 代码目录结构说明,可以说明软件的基本原理;
  • 常见问题说明。