目录组织方式
假设项目名为foo，建议方便快捷的目录结构如下：
Foo/
| - - bin/
| | - - foo
|
| - - foo/
| | - - tests/
| | | - - __init__.py
| | | - - test_main.py
| |
| | - - __init__.py
| | - - __main.py
|
| - - docs/
| | - - conf.py
| | - - abc.rst
|
| - - setup.py
| - - requirements.text
| - - README
简要解释：
1、bin/：存放项目的一些可执行文件，当然也可以起名script/之类的也行。
2、foo/：存放项目所有源代码。（1）源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。（2）其子目录tests/存放单元测试代码；（3）程序的入口最好命名为main.py。
3、docs/：存放一些文档
4、setup.py:安装、部署、打包的脚本。
5、requirements.txt：存放软件依赖的外部python包列表。
6、README：项目说明文件。
除此之外，有些方案给出了更加多的内容。比如
LICENSE.txt,ChangeLog.txt等文件，这些东西主要是项目开源的时候要用到。开源项目文件说明：https://jeffknupp.com/blog/2013/08/16/open-sourcing-a-python-project-the-right-way/
关于README内容
目的是能简要描述该项目的信息，让读者快速了解这个项目。
他需要说明一下几个事项：
1、软件定位，软件的基本功能。
2、运行代码的方法：安装环境、启动命令等。
3、简要的使用说明。
4、代码目录结构说明，更详细点可以说明软件的基本原理。
5、常见问题说明。
在软件开发初期，由于开发过程中以上内容可能不明确或者发生变化，并不是一定要在一开始就将所有信息写全。但在项目完结的时候，是需要撰写这样的一个文档。
关于requirements.txt和setup.py
setup.py
一般来说，用setup.py来管理代码的打包、安装、部署问题。业界标准的写法是用python流行的打包工具stepstools来管理这些事情。这种方式普遍应用于开源项目中。不过这里的核心思想不是用标准化的工具来解决这些问题，而是说，一个项目一定要有一个安装部署工具，能快速便捷的在一台新机器上将环境安装好、代码部署好和将程序运行起来。
BUGS1：
1、安装环境时经常忘记最近又添加了一个新的Python包，结果一到线上运行程序就出错。
2、Python包的版本依赖问题，有时候程序中使用的是一个版本的Python，但官方的已经是最新的包了，通过手动安装就可能安装错了。
3、如果依赖的包很多的话，一个一个安装这些依赖是很费时的事情。
4、新手开始写项目的时候，将程序跑起来非常麻烦，因为可能经常忘了要怎么安装各种依赖。
setup.py可以将这些事情自动化起来，提高效率、减少出错的概率。“复杂的东西自动化，能自动化的东西一定要自动化。”是个非常好的习惯。
stepstools的文档比较庞大，刚接触的话，可能不太好找到切入点。学习技术的方式就是看他人是怎么用的，可以参考一下Python的一个Web框架，flask是如何写的setup.py
requirements.txt
这个文件存在的目的：
1、方便开发者维护软件包的依赖。将开发过程中新添加进这个列表中，避免在setup.py安装依赖时漏掉软件包。
2、方便读者明确项目使用了那些Python包。
这个文件的格式是每一行包含一个包依赖的说明，通常是flask>=0.10这种格式，要求是这个格式能被pip识别，这样可以简单的通过pip install -r requirements.txt来把所有Python 包依赖都安装好。
关于配置文件的使用方法
注意，在上面的目录结构中，没有将conf.py放在源代码目录下，而是放在docs/目录下。
很多项目的配置方法如下：
1、配置文件写在一个或多个Python文件中，比如此处的conf.py。
2、项目中哪个模块用到这个配置文件就直接通过import conf这种形式来在代码中使用配置。
这种方法的弊端：
1、这让单元测试变的困难（因为模块内部依赖了外部配置）
2、另一方面配置文件作为用户控制程序的接口，应当可以由用户自由指定该文件的路径。
3、程序组件可复用性太差，因为贯穿所有模块的代码硬编码方式，使得大部分模块都依赖conf.py这个文件。
所以配置的使用，更好的方式是：
1、模块的配置都是可以灵活配置的，不受外部配置文件的影响。
2、程序的配置也是可以灵活控制的。
能够佐证这个思想的是，用过nginx和mysql的人都知道nginx 、mysql这些程序都可以自由的指定用户配置。
所以，不应当在代码中直接import conf来使用配置文件。上面目录结构中的conf.py，也是给出的一个配置样例，不是在写死在程序中直接引用的配置文件。可以通过给main.py启动参数指定配置路径的方式让程序读取配置内容。当然，这里的cong.py可以换个类型的名字，比如settings.py。或者也可以使用其他格式的内容来编写配置文件，比如settings.yaml之类的。