python包的创建变得简单
picnic的Python项目详细描述
py帮助您编写python包:
picnic.py new PackageName
这将创建一个目录,其中包含开始所需的所有文件:
/PackageName_project /PackageName /setup.py /README.rst /packagename /__init__.py /packagename.py
还不够吗?试试这个:
picnic.py new MyPackage --author=Zulko --sphinx --gitinit --dev
现在您有了一个新包,其中包含sphinx文档和项目的git存储库。并且您的软件包已经以development模式安装在您的计算机上(这意味着您可以直接从该文件夹更改代码,而无需重新安装项目)。
这些命令也适用于已编写的包。例如,如果我进入setup.py文件夹并键入
picnic.py --remote=https://github.com/Zulko/MyPackage.git --ghpages<>这将把我的项目链接到一个现有的GITHUB存储库,并初始化这个项目的GITHUB页面。现在我只需要在github上推送这些代码(见下面的食谱),它将为我提供this repo的代码,以及this page的联机文档(您可以随后更改外观)。
安装和定制
py需要一个很棒的docopt包,您可以用经典的
pip python install docopt
要安装picnic.py,请获取代码的zip,例如Github,然后将其解压缩到某个文件夹中。您可以查看子文件夹picnic/files中的文件模板README.rst、setup.py等,并根据需要进行自定义。
然后,在setup.py的文件夹中,键入
sudo python setup.py install
或者更好的方法是,改用此命令,它将使您能够在安装后更改模板:
sudo python setup.py develop
你完了!注意,您也可以用pip安装picnic.py,但不建议这样做,因为它不允许您更改模板。
贡献!
py是一个开源软件,最初由Zulko编写,在mit许可下发布。请帮助使野餐更好,例如通过扩大能力,为健全的标准提供建议,如果你是一个有经验的模块制造商,报告错误,等等。我们喜欢叉子和拉再任务!
说到分支机构,有another one正在积极发展。
野餐正在开发中。这是你应该去那里进行故障排除和错误报告。
食谱
在本节中,我们将向python、sphinx、git和github初学者解释如何使用picnic.py创建的文件。您还可以使用从控制台获得帮助
picnic.py --help
创建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文件(以指定不包含在repo中的文件类型),然后键入这些行
git init git add . git commit -m "Initial commit"
--git选项正好完成了这一切:它向文件夹中添加一个.gitignore文件并运行所有这些命令。一定要在setup.py所在的目录中运行它。
链接到github上的存储库
要将这个git存储库放在github上,首先在github上创建一个repo(当他们问您是否包含readme文件时,请拒绝)。Github Sho公司我会给你回购的网址,比如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 repo,我通常会执行
git commit -a -m "my description of the commit"
在此之后,推动对在线github repo的更改:
git push origin master
创建github页面
在这里,我们假设您已经用
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页面创建一个特殊的git存储库,该目录是文档的输出目录。
当您对文档的外观满意时,可以进入文件夹built_docs/html,然后键入
git commit -a -m "my description of the commit" git push origin gh-pages
就这些!