一个蟒蛇模块的骨架包
makenew-python-package的Python项目详细描述
python模块的包骨架。
说明
不到一分钟就启动一个新的Python包。
功能
- 使用setuptools进行包管理并发布到PyPI。
- 使用Pipenv保护依赖关系管理。
- 用Pylint起毛。
- CircleCI准备好了。
- Keep a CHANGELOG。
- 与EditorConfig编码一致。
- 来自Shields.io的徽章。
启动新项目
使用克隆此存储库的主分支
$ git clone --single-branch https://github.com/makenew/python-package.git new-python-package $ cd new-python-package
（可选）重置为最新的 release使用
$ git reset --hard v1.2.0
运行
$ ./makenew.sh
并按照提示操作。这将替换样板文件，删除 本身，并为提交准备更改。此脚本假定项目 存储库将托管在github上。换个地方，你 必须手动更新URL。
填写自述描述部分。
如果choosing a license不是 提供了一个：updateLICENSE.txt，readme许可证部分，和 setup.py使用您选择的许可证。
根据您命名测试的方式，可能需要添加它们 到setup.py中的find_packages排除列表。
更新
如果您想从这个框架中提取将来的更新，可以获取 并合并此存储库中的更改。
如果此存储库已设置为origin，请将其重命名为 upstream与
$ git remote rename origin upstream
然后将origin分支配置为普通分支。
否则，请使用
$ git remote add upstream https://github.com/makenew/python-package.git
然后，您可以使用
$ git fetch upstream $ git merge upstream/master
更改日志
注意，CHANGELOG.md只是这个骨架的模板。这个 此项目的实际更改记录在提交历史和 总结如下 Releases。
安装
此包在Python Package Index (PyPI)上注册 作为makenew_python_package。
用
安装$ pipenv install makenew_python_package
如果您正在编写依赖于此的python包， 将此添加到setup.py中的需求中。
开发和测试
源代码
makenew-python-package source托管在github上。 用
$ git clone https://github.com/makenew/python-package.git
测试
lint代码，使用
$ python setup.py lint
使用
运行测试$ python setup.py test
出版
更新setup.py中的变更日志和版本号。 然后创建一个新的提交和标记，例如， 提交消息应该类似于1.0.0和git标记v1.0.0。 然后按下将触发Circleci发布作业的新Git标记。
圆圈
circleci应已配置：此部分仅供参考。
必须在CircleCI上设置以下环境变量：
- TWINE_USERNAME：在pypi上发布的用户名。
- TWINE_PASSWORD：在pypi上发布的密码。
这些可以手动设置，也可以通过运行脚本./circleci/envvars.sh来设置。
贡献
请提交并评论错误报告和功能请求。
提交修补程序：
- 叉它（https://github.com/makenew/python-package/fork）。
- 创建功能分支（git checkout -bmy-new-feature）。
- 做出改变。编写并运行测试。
- 提交更改（git commit -am 'Add some feature'）。
- 推到分支（git push origin my-new-feature）。
- 创建新的拉取请求。
许可证
这个python包是在mit许可下授权的。
保修
本软件由版权所有者和贡献者“按原样”提供，并且 任何明示或默示保证，包括但不限于 适销性和适用性保证或者某个特定的目的 否认。在任何情况下，版权所有人或贡献者均不负责： 任何直接、间接、附带、特殊、惩戒性或间接损害 （包括但不限于替代货物或服务的采购； 使用、数据或利润的损失；或营业中断），无论是何种原因造成的 任何责任理论，无论是合同责任、严格责任还是侵权责任； （包括疏忽或其他）以任何方式产生的 软件，即使被告知有这种损坏的可能性。
欢迎加入QQ群-->： 979659372
