PyHatch 0.0.19

pyhatch

pyhatch初始化新python项目的文件和目录结构。

参见代码：https://github.com/sonofeft/PyHatch

参见文档：http://pyhatch.readthedocs.org/en/latest/

见PYPI页：https://pypi.python.org/pypi/pyhatch

pyhatch的目的是帮助技术程序员专注于他们的python 科学与工程问题的规划工作 构建和维护所需的许多源代码组织问题 质量代码库。pyhatch将初始化 项目文件，文档，单元测试和许可。

每次启动新项目时，用户都会填写一些简单的表单 选择项目布局的目录位置。使用的布局 PyHatch如下所示。：

MyProject/
    myproject/
        __init__.py
        mycode.py
        examples/
            example_1.py
        tests/
            __init__.py
            test_mycode.py
    docs/
        conf.py
        index.rst
    .travis.yml
    HISTORY.rst
    history_from_github_api.py
    LICENSE.txt
    MANIFEST.in
    README.rst
    requirements.txt
    setup.cfg
    setup.py
    tox.ini

pyhatch的一个目标是鼓励单元测试。为此，一个“测试” 目录已创建并初始化。的三个常见位置 测试脚本如下所示，pyhatch使用第三个选项。用户是免费的 修改此布局，但鼓励在 以下布局。

放置测试脚本：

1. 与mycode.py/myproject/myproject/
2. 与代码目录/myproject/tests/
处于同一级别
3. 代码目录/myproject/myproject/tests/
下的一个级别

还创建了tox.ini文件，以简化使用 许多不同的python版本。Tox需要单独安装， 然而，新项目只需要在本地执行tox就可以使用它。

docs/子目录包含运行sphinx和创建 项目文档。它设置为自动读取项目 *.py文件并动态包含代码文档。注意Sphinx将 需要单独安装。

在docs/子目录中运行make html（安装了sphinx）以生成 项目的HTML文档。文件index.html是 docs/u build/html目录中的文档。

examples/子目录包含使用项目的任何示例文件。

Pyhatch的希望是早期组织将产生更好的代码 以及测试驱动开发。

注意，配置文件（pyhatch.cfg）是在用户主页中创建的 目录。该配置文件保存的项目和个人数据 将帮助在第二次使用pyhatch时自动填充pyhatch gui。

参见代码：https://github.com/sonofeft/PyHatch

参见文档：http://pyhatch.readthedocs.org/en/latest/