用于轻松创建python模块的模块
pyckstart的Python项目详细描述
pyckstart是一个简单的模板引擎,用于编写基于jinja2的python模块。
它可以为简单的python模块生成基本布局,包括或不包括cli、unitest和git本地repo初始化。
打开控制台并在任何文件夹中键入
pyckstart -n ModuleName
它将生成以下文件夹,其中包含(几乎?)所有你需要的文件。剩下的工作就是编写实际的代码:
~: find ModuleName ModuleName ModuleName/README.rst ModuleName/setup.py ModuleName/src ModuleName/src/modulename ModuleName/src/modulename/modulename.py ModuleName/src/modulename/__init__.py ModuleName/LICENCE.txt ModuleName/MANIFEST.in
然后,您可以将CD放入模块文件夹并键入:
python setup.py develop
选项
Usage: pyckstart -n module_name [options]
- Options:
-h, --help show this help message and exit -d, --debug Enable debug output -q, --quiet Disable output -v VERSION, --version=VERSION Module version -t, --tests Create tests layout -g, --git Enable git repo creation -c, --cli Create CLI layout -p PY_VERSION, --pyversion=PY_VERSION Python version for #!/usr/bin/env python#. Default value : current python major version (2) -n PACKAGE_NAME, --name=PACKAGE_NAME Package name -i, --install Install templates in home folder -f, --force Will override existing files. Use with care.
示例
要使用cli、unitest和git创建新模块,只需键入:
pyckstart -t -c -g -n MyModulename
我将生成以下布局:
find MyModulename | grep -v git MyModulename MyModulename/README.rst MyModulename/setup.py MyModulename/src MyModulename/src/tests MyModulename/src/tests/test_mymodulename.py MyModulename/src/tests/__init__.py MyModulename/src/mymodulename MyModulename/src/mymodulename/mymodulename.py MyModulename/src/mymodulename/__init__.py MyModulename/src/bin MyModulename/src/bin/mymodulename.py MyModulename/src/bin/__init__.py MyModulename/LICENCE.txt MyModulename/MANIFEST.in
然后,您可以将CD放入模块文件夹并键入:
# install it in dev mode python setup.py develop # run unitests python setup.py test
通过在dev模式下安装,您的模块自动创建了cli入口点。然后,您可以在终端中键入:
mymodulename
wich将运行文件mymodulename/src/bin/mymodulename.py。
安装和定制
从源头
git clone https://github.com/jcsaaddupuy/pyckstart.git
cd pyckstart
sudo python setup.py install
来自Pypi
只需pip安装:
pip install pyckstart --pre
定制
如果您想拉皮条客的模板,您可以安装在本地在您的家庭文件夹:
pyckstart -i
所有模板都将复制到~/.pyckstart/files/,您可以自由编辑以覆盖默认值。
贡献
pyckstart是一个开源软件,最初由Zulko编写,在mit许可下发布。请帮助使Pyckstart或野餐更好,例如,通过扩展功能,提供健全的标准建议,如果你是一个经验丰富的模块制造商,报告错误,等等。我们喜欢叉子和拉再任务! pyckstart正在Github上开发,这是您应该进行故障排除和错误报告的地方。