帮助为Windows用户创建包分发设置,该设置还可以运行测试、检查和创建HTML和PDF文档。
easysetup的Python项目详细描述
帮助为Windows用户创建包分发设置,该设置还可以运行测试、检查和创建HTML和PDF文档。
说明、功能和待办事项
说明
帮助为Windows用户创建包分发设置,该设置还可以运行测试并创建HTML和PDF文档。
在没有选项的情况下运行easysetup时,当前目录中的所有内容都将移动到一个bak目录中。
在运行easysetup之后,您可以在当前目录中找到一个build.cmd,它应该运行来构建您的应用程序(执行build-h以查看使用选项)。
在首次运行nning build.cmd之前,应执行
$ pip install -r requirements-dev.txt
按要求安装。
功能:
- 简单易用,只需从应用程序安装目录运行easy setup(在没有选项的情况下运行时,它会将当前目录中的所有内容备份到-bak目录)。
- 允许创建source、wheel、win(exe或msi)、py2exe、egg、dumb(windows上的zip,gnu linux上的tar/ztar/gztar/zip,将来的版本)和rpm(gnu linux上的版本)dists。
- 所有安装配置都在一个文件(appinfo.py)中。
- 运行测试并创建HTML和PDF文档(当然,如果有)。
- 创建index.html,并将其重定向到rtd,以便在托管文档时使用。
- 为travis、shippable、appveyor和tox创建模板。
- 为开发需求创建模板。
- 为安装要求创建模板。
- 为git vcs异常创建模板。
- 为要包含在设置中的文件创建模板。
- 为自述文件创建模板。
- 创建控制盘设置和Sphinx文档上载的模板。
- 可以在doc目录中创建模板文件(假设使用了sphinx并且已经执行了sphinx快速启动命令)。
- 可以在doc目录中创建一个更新的reference.rst(假定前一项具有autodoc扩展名)。
- 更新基于USAG.TXT的Read Me.RST中的使用节,如果它存在于应用程序目录内。
- 保存答案(默认作者、默认电子邮件、默认许可证、默认URL和默认版本)以供将来在其他应用程序中使用。
- 在每个生成的doc目录中重新创建reference.rst(可以通过将rebuild_reference=yes更改为其他值在build.cmd中禁用)。
- 如果安装目录为空,则在应用程序目录内创建主模板文件。
- 检查flake8和py3与pylint兼容的源代码。
- 为pypi、pypi文档站点和rtd将url添加到readme.rst。
- 将py文件中的所有待办事项收集到readme.rst to do部分。
待办事项
easysetup.py:auto rebuild requirements.txt在每个dist构建上。 easysetup.py:py2和py3中的cxf easysetup.py:检查和错误消息 py:将build.cmd功能移到easysetup.py。
安装、使用和选项
安装
$ pip install easysetup
用法
$ easysetup
选项
$ easysetup -h usage: easysetup [-option] optional arguments: -d, --doc creates template files in the doc directory -h, --help show this help message -l, --license show license -q, --quiet no banner -r, --reference creates an updated reference.rst in the doc directory -V, --version show version No arguments (or only -q, --quiet) creates setup files. easysetup should always be run from the application setup directory.
资源和贡献
资源
贡献
如果上面的其他存储库是github或兼容的,请遵循以下准则进行贡献:
- 叉repository。
- 创建master的分支并将更改提交给它。
- 确保使用以下格式将您的姓名添加到authors.rst文件的末尾: Name <email@domain.com>
- 向主分支提交拉取请求。
版权2009-2015年Joao Carlos Roseta Matos。根据GNU通用公共许可证v2或更高版本(GPLV2+)授权。