github-tools 0.1.7

包布局

如果您是从头开始，可以使用paster创建基本布局：

paster create -t gh_package <project name>

项目名称将用于pypi以及您的Github仓库（http://github.com/<user>/<project name>）。

要完成您的开发环境设置，创建一个虚拟环境和以开发模式部署您的包：

cd <project name>
python bootstrap.py --no-site-packages

基本包附带一个虚拟环境引导脚本，用于创建独立的Python环境。要在您的shell中激活此环境，请运行：

source ./virtual-env/bin/activate
# or .\virtual-env\Scripts\activate.bat on windows

最后

paver generate_setup minilib develop.

Paver会将一个setup.py文件添加到您的包中，以及一个便携式Paver库（由setup.py要求），并以开发模式部署您的应用程序；包含您的包的“src”文件夹被添加到Python路径中。

setup.py文件内容不多。所有setup()参数都设置在pavement.py中。所有的distutils和setuptools任务都可以通过paver使用，并且很容易扩展或添加自己的命令（有关更多详细信息，请参阅paver文档）。

您现在可以编写您的包（在src/中）及其文档（在docs/source中）。您现在可能应该开始跟踪您的项目了。

git init
git add .
git commit -m "initial import"

Github项目创建

当您准备好分享您的工作时，您需要在GitHub上创建一个仓库并将本地仓库推送到那里。Paver可以为您完成这项工作。Paver需要您的GitHub用户名和令牌来创建仓库。您可以使用以下命令设置它们：

git config --global github.user <user>
git config --global github.token <token>

您可以在您的Github账户页面找到您的令牌。

然后，为了创建仓库并上传您的项目：

paver gh_register

文档托管

一旦项目创建完成，您就可以创建您的gh-pages分支并将其上传到GitHub。

paver gh_pages_create gh_pages_build

Paver将在您的项目的docs/build/html处创建一个项目子模块，创建一个gh-pages根分支并将分支推送到您的项目。然后它构建html文档。要清理html构建文件夹，它会更新子模块（您将丢失未提交和推送的更改），删除所有文件和目录（除了.git/），并重新构建文档。

当您的文档可以发布时，只需将您的gh-pages子模块推送到GitHub。

paver gh_pages_build gh_pages_update -m "update docs with..."

您的文档应该可以在http://<user name>.github.com/<project name>上找到。

您可能还想更新子模块引用（子模块指向远程仓库的特定提交，而不是特定分支的HEAD）。

git add docs/build/html
git commit -m "update gh-pages submodule"