软件目录结构规范
alex_老男孩:
为什么要设计好目录结构？
“设计项目目录结构”，就和“胆码编码风格”一样，属于个人风格问题。对于这种风格上的规范，一直都存在两种态度：
1.一类同学认为，这种个人风格问题“无关紧要”理由是能让程序work就好，风格问题根本不是问题。
2.另一类同学认为，规范化能更好的控制程序结构，让程序具有更高的可读性。
我比较偏向理解后者的，因为我是一种同学思想行为下的直接受害者。我曾静维护过一个非常不好的项目，其实逻辑并不复杂，但是却耗费了我非常长的时间去理解它想要表达的意思。从此个人对提高项目可读性、可维护性的要求就很高了。
“项目目录结构”其实额是属于“可读性和可维护性”的范畴，我们设置一个层次清晰的目录结构，就是为了达到一下两点：
1.可读性高：不熟悉换个项目的代码人，一眼就能看懂目录结构，知道程序的启动脚本是那个，测试目录在那里，配置文件在哪里等等。从而非常快速的了解这个项目。
2.可维护性高：定义好组织规范后，维护者就能很明确地知道，新增的那个文件和代码应该在什么目录之下。这个好处是，随着时间的退役，代码/配置的规模增加，项目结构不会混乱，乃然能够组织良好。
所以，我认为，保持一个层次清晰的目录结构是有必要的，更何况组织一个良好的工程目录，其实是一键很简单的事情。
目录组织方式：
关于如何组织一个较好的python工程目录结构，已经有一些得到了共识的目录结构，在stackoverflow的这个问题上，能看到大家对python目录结构的讨论。
简要解释一下：
1.bin/：存放项目的一些可执行文件，当然你可以起名script/之类的也行
2.foo/：存放项目的所有源代码，1.源代码中所有模块、包都应该放在此目录。不要置于顶层目录。2.其子目录tests/存放单元测试代码 3.程序的入口最好命名为main.py
3.docs/：存放一些文档。
4.setup.py：安装、不熟、打包的脚本
5.requirement。txt：存放润阿金依赖的外部python包列表
6.readme：项目说明文件。
除此之外，有一些方案给出了更加多的内容。比如license.txt ，changelog。txt文件等，我没有列在这里，因为这些东西主要是项目开元的时候需要用到的。
关于README的内容
这个我觉得每个项目都应该有的一个文件,目的是能简要描述该项目的信息,让读者快速了解这个项目.
它需要说明一下几个事项:
1.软件定位,软件的基本功能
2.运行代码的方法:安装环境、启动命令等.
3.简要的使用说明
4.代码目录机构说明,更详细点可以说明软件的基本原理.
5.常见问题说明.
关于requirements.txt 和 setup.py
一般来说,用setup.py来管理diamante的打包、安装、部署问题.业界标准的写法是用python流行的打包工具setuptools来管理这些事情.这种方式普遍应用于开源项目中.不过这里的核心思想不是用标准化的工具来解决这些问题,而是说,一个项目一定要有一个安装部署工具,能够快速便捷的在一台新的机器上将环境装好、代码部署好将程序运行起来.
我刚开始接触python写项目的时候,安祖航环境、部署代码、运行程序这个过程全是手动完成,遇到以下问题:
1.安装环境时经常忘了最近又添加了一个新的python包,结果一到线上运行,程序就出错了.
2.python包的版本依赖问题,有时候我们程序中使用的是一个版本的python包,但是官方的已经是最新的包了,通过手动安装就可能装错.
3.如果依赖的包很多的话,一个一个安装这些依赖是很费时的事情.
4.新同学开始写项目的时候,将程序跑起来非常麻烦,因为可能经常忘了要怎么安装各种依赖.
setup.py可以将这些事情自动化起来,提高效率、减少出错的概率."复杂的东西自动化,能自动化的东西一定要自动化"是一个非常好的习惯
setuptools的文档比较庞大,刚接触的话,可能不太好好找到切入点,学习技术的方式就是看别人怎么用的,可以参考一些python的一个web框架flask是如何写的setup.py
当然,简单点自己写个安装脚本(deploy.sh)替代setup.py也未尝不可.
requirements.txt
这个文件存在目的是:
1.方便开发者维护软件的包依赖.将开发过程中新增的包添加进这个列表中,避免在setup.py安装依赖时漏掉软件包.
2.方便读者明确项目使用了哪些python包
这个的格式是每一行包含一个包依赖的说明,通常是flask >= 0.10这个格式,要求是这个格式被pip识别,这样就可以简单的通过pip install -r requirements.txt 来包所有python包依赖都装好了.