学步园

问题：http://learnpythonthehardway.org/book/ex46.html

一书exe 46中提到了项目架构，这是之前写程序没有考虑的，一个项目一定有规范和标准，所以也算是一种新内容的学习，摘抄和补充下来，供后续参考使用。

当然整个使用环境是相对于linux来说的（win下的话，直接程序py2exe打包即可），但共同点是项目文件布局基本相同。

1、项目文件布局

 骨架目录一般包括项目文件布局、自动化测试代码，模组，以及安装脚本。当建立一个新项目的时候，只要把这个目录复制过去，改改目录的名字，再编辑里边的文件就行了。

一般为：

project ->skeleton->bin

      ->NAME -> __init__.py

      ->tests   -> __init__.py

                      ->NAME_tests.py

      ->docs

      ->setup.py

其中NAME_tests.py内容如下：

#/bin/env python
#filename:name_tests.py

from nose.tools import *
import NAME

def setup():
        print 'setup!'

def teardown():
        print 'TEAR DOWN!'

def test_basic():
        print 'I RAN!'

其中setup.py内容如下：

#!/bin/env/python
#filename:setup.py

try:
        from setuptools import setup
except ImportError:
        from distutils.core import setup

config = {
        'description': 'project name',
        'author': 'ower name',
        'url': 'URL to get it at.',
        'download_url': 'Where to download it.',
        'author_email': 'My email.',
        'version': 'o.1',
        'install_requires': ['nose'],
        'packages': ['NAME'],
        'scripts': [],
        'name': 'projectname'
}

setup(**config)

这样得到的结构就是：

.:
skeleton

./skeleton:
bin  docs  NAME  setup.py  tests

./skeleton/bin:

./skeleton/docs:

./skeleton/NAME:
__init__.py

./skeleton/tests:
__init__.py  NAME_tests.py

2、目录配置建立检查测试

在skeleton目录下运行：得到结果如下，这说明目录建立正确。

[root@localhost skeleton]# nosetests#这是linux下的一个命令
.
----------------------------------------------------------------------
Ran 1 test in 0.039s

OK
[root@localhost skeleton]#

3、搭建项目环境，安装软件包

接下来需要安装下面的软件包：

1. pip –
   http://pypi.python.org/pypi/pip
2. distribute –
   http://pypi.python.org/pypi/distribute
3. nose –
   http://pypi.python.org/pypi/nose/
4. virtualenv –
   http://pypi.python.org/pypi/virtualenv

不仅只是手动下载并且安装这些软件包，而且应该看一下别人的建议，尤其看看针对你的操作系统别人是怎样建议你安装和使用的。同样的软件包在不一样的操作系统上面的安装方式是不一样的，不一样版本的 Linux 和 OSX 会有不同，而 Windows 更是不同。

4、后续项目创建

以后每次新建一个项目时，只要做下面的事情就可以了：

1. 拷贝这份骨架目录，把名字改成你新项目的名字。
2. 再将 NAME 模组更名为你需要的名字，它可以是你项目的名字，当然别的名字也行。
3. 编辑 setup.py 让它包含你新项目的相关信息。
4. 重命名 tests/NAME_tests.py ，让它的名字匹配到你模组的名字。
5. 使用 nosetests 检查有无错误。
6. 开始写代码吧。

5、资源补充

下面根据网上资源做一些补充

主要是让现有Python代码的开源过程尽可能清晰和流畅，可以把现有的代码转换成一个能够鼓励他人使用和贡献的开源项目。

项目布局：

每个项目至少应该有下面三个目录：

1. doc目录，包括项目文档
2. 项目目录，以项目命名，存储实际的Python包
3. test目录，包含下面两部分
   1. 在这个目录下包括了测试代码和资源
   2. 作为一个独立顶级包

setuptools 和 setup.py文件

setup.py文件，被distuils包用来安装Python包的。对于任何一个项目，它都是一个很重要的文件，因为它包含了版本，包依赖信息，PyPi需要的项目描述，你的名字和联系信息，以及其它一些信息。它允许以编程的方式搜索安装包，提供元数据和指令说明让工具如何做。

setuptools包（实际上就是对distutils的增强）简单化了建立发布python包。使用setuptools给python包打包，和distutils打包没什么区别。这实在是没有任何理由不使用它。

下面是作者举的一个例子：

参考文献：

http://www.oschina.net/translate/open-sourcing-a-python-project-the-right-way?lang=chs&page=1#

更加详细的请参考转载文章下一篇：

《以正确的方式开源 Python 项目》

http://www.oschina.net/translate/open-sourcing-a-python-project-the-right-way?lang=chs&page=2#