创建python包的命令行工具
do-pack的Python项目详细描述
创建python包的简单快速的命令行工具。
安装
$ pip install do-pack
用法
config命令
$ do config
使用它填充公共字段一次(如果执行两次 将覆盖以前的配置)。
创建默认的python项目
$ do create <project-name>
使用其中一个可用模板创建项目
$ do create <project-name>-t <template>
-t是–template的缩写。
可用模板:
- 烧瓶
- django
- pymin(最小python项目)
要使用自己的模板,需要将其存储在当前的.json文件中 目录,例如:
my_template.json
使用方法:
$ do create my_project -t my_template
新项目的逐步设置
$ do assistant
此命令帮助您填写:
- setup.py
- AUTHORS.rst
- LICENSE
- .gitignore带有linux,macos的规则, windows,python,visual studio,vs代码,sublime text和 pycharm(由https://www.gitignore.io/制成)。
默认文件夹结构和模板
这是使用时创建的文件夹结构 do create <my_project>和do assistant。
project_folder ├── project │ ├── __init__.py │ └── project.py ├── docs │ └── index.rst ├── tests │ ├── __init__.py │ └── project_test.py ├── .gitignore ├── LICENSE ├── README.rst ├── AUTHORS.rst ├── setup.py ├── requirements.txt └── test-requirements.txt
- 模板系统使用一个.json文件,其中键是 文件夹和值是文件。
- 每次创建文件夹时,程序将自动输入 它。如果您需要退出该文件夹,那么下一个文件夹放置在 在同一个目录中,根据需要多次在文件(值)中放置<--。
- 文件夹(键)base和bin将替换为项目名称。
- project.py替换为项目名(例如 my_project.py)。
- 在test_projet.py中,project替换为项目名 (例如test_my_project.py)
这是默认文件夹结构的模板:
{ "base": [ "LICENSE", "setup.py", "README.rst", "AUTHORS.rst", ".gitignore", "requirements.txt", "test-requirements.txt", "MANIFEST.in" ], "bin": [ "project.py", "__init__.py", "<--" ], "docs": [ "index.rst", "<--" ], "tests": [ "__init__.py", "test_project.py", "<--" ] }
待办事项
- 为assistant命令实现--template(75%)。
- 将github用户名添加到项目的config命令中 网址。
- 生成文档(sphinx)。