github-tools 0.1.7

包装布局

如果您是从头开始，请使用粘贴器创建基本布局：

paster create -t gh_package <project name>

项目名称将用于pypi和github存储库 （http://github.com/<user>/<project name>）。

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

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

基本包附带一个virtualenv boostrap脚本 创建一个独立的python环境。激活此环境 在您的壳中，运行：

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

最后：

paver generate_setup minilib develop.

摊铺机将setup.py文件添加到包和便携式摊铺机库中 （由setup.py要求），并以开发模式部署应用程序； 包含包的“src”文件夹被添加到python路径中。

setup.py不包含太多内容。所有setup()参数都设置在 pavement.py。所有distutils和setuptools任务都可与paver一起使用 而且很容易扩展或添加自己的命令（请参见 paver documentation 更多细节）。

您已经准备好编写包（在src/中）及其文档 （在docs/source中）。您现在应该开始跟踪您的项目：

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

github项目创建

当你准备好分享你的工作时，你需要 在github创建一个存储库并推送本地存储库。摊铺机能做到 为你。paver需要您的github用户名和令牌来创建 储存库。您可以使用以下命令设置它们：

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

你可以在你的 Github account page。

然后，创建存储库并上载项目：

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://<username>.github.com/<project name>处。

您可能还需要更新子模块引用（子模块点 在远程存储库上进行特定的提交，而不是向头部提交 特定分支的：

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