picnic 0.0.0.5

创建 Python 包

要开始一个新项目，您输入

picnic.py new PackageName

安装包（之后您将能够修改代码）输入

python setup.py develop

或等价于

picnic.py --dev

现在我们可以开始编码了：我们进入目录 PackageName/packagename，在文件 packagename.py 中编写

def say_hello():
    print "Hello world !"

要检查是否成功，打开一个 Python 控制台（在任何文件夹中）并输入

>>> import packagename
>>> packagename.say_hello()
 Hello World !

创建 Sphinx 文档

要初始化 Sphinx 文档，您输入

picnic.py [new PackageName] --author="Your Name" --sphinx

文档源将位于 docs 目录中，构建的（html）文档将位于 built_docs/html/ 文件夹中。在您对文档进行了更改后，您可以通过进入 docs 仓库并输入来预览文档

make html
firefox ../../built_docs/html/index.html

为了方便，这两行已经写入 docs/make_html.sh 文件中，因此您只需输入

./make_html.sh

创建 git 仓库

要按照经典方式创建 git 仓库，通常在您的文件夹中添加一个 .gitignore 文件（以指定不包含在仓库中的文件类型），并输入这些行

git init
git add .
git commit -m "Initial commit"

该 --git 选项确实做了所有这些：它向文件夹添加一个 .gitignore 文件并运行所有这些命令。请确保在您的 setup.py 所在目录中运行它。

链接到 Github 上的仓库

要将此 git 仓库放在 Github 上，首先在 Github 上创建一个仓库（当询问您是否要包含 README 文件时，请选择否）。Github 应该会提供仓库的 URL，例如 https://github.com/Zulko/MyPackage.git。然后在控制台中输入

git add remote origin https://github.com/Zulko/MyPackage.git

或等价于

picnic.py --remote=https://github.com/Zulko/MyPackage.git

通常，我将更改提交到 git 仓库

git commit -a -m "my description of the commit"

然后，将更改推送到在线 Github 仓库

git push origin master

创建 Github-pages

这里我们假设您已经使用

git add remote origin https://link/to/your/repo.git

或等价于

picnic.py --remote=https://link/to/your/repo.git

现在您只需要做

picnic.py --ghpages

这将在 built_docs/html 目录中创建一个用于 Github Pages 的特殊 git 仓库，这是文档的输出目录。

当您对文档的外观满意时，进入 built_docs/html 文件夹并输入

git commit -a -m "my description of the commit"
git push origin gh-pages

这就全部了！