目录结构
设计好目录结构
- 可读性高
- 可维护性高
比如一个Foo项目 Foo/ | --- bin/ | --- foo | |
---|---|---|---|
--- foo/ | |||
--- tests/ | |||
--- _init__.py | |||
--- test_main.py | |||
--- init.py | |||
--- main.py | |||
---doc | |||
--- conf.py | |||
---abc.rst | |||
--- setup.py | |||
--- requirement.txt | |||
--- README |
简要解释一下:
- bin/:存放项目的一些可执行文件,当然你可以起名script/之类的也行
- foo/:存放项目的所有源代码(1)源代码中额所有模块,包都应该放在这个目录,不要置于顶层目录。(2)其子目录tests/存放单元测试的代码。(3)程序的入口最好命名为main.py
- docs/:存放一些文档
- setup.py:安装、部署、打包的脚本
- requirements.txt:存放软件依赖的外部python包列表
- README:项目说明文件
README内容: - 软件定位,软件的基本功能
- 运行代码的方法,安装环境,启动命令等
- 简要的使用说明
- 代码目录结构说明,更详细点可以说明软件的基本原理
- 常见问题说明
转载于:https://blog.51cto.com/10777193/2093372