Cookiecutter Python库演示项目的演示
cookiecutter-python-library-demo的Python项目详细描述
这是一个用Cookiecutter Python Library模板创建的项目,并且 准备用于创建新的python库。
只要检查自述文件和文档,使它们适应您的项目,就可以完成。
记住,如果你想创建一个新的项目,最好是重用 Cookiecutter Python库模板,因为这将设置初始 根据它需要的一些数据进行项目。
功能
默认情况下,项目具有以下功能:
- Travis配置文件
- 自定义setup.py模块以最小化配置,并使用tox进行测试
- 文档使用Sphinx和Sphinx Docs Theme
- 准备通过毒物测试
- 准备在Python2.6、2.7、3.2、3.3、3.4上运行测试
- 准备对pypy和pypy 3运行测试
- 准备在Jython上运行测试
- 准备运行覆盖率测试并与Coveralls
- 准备为Sphinx文档运行测试
文件
检查latest docs以获取文档的最新版本。
您还可以从“docs”中保存的源文件创建文档 文件夹,在斯芬克斯的帮助下。为此,请使用makefile或make.bat 文件,包含在该文件夹中。
先决条件
该项目已在以下版本的解释器中测试:
- Python2.6
- python 2.7版
- python 3.2
- Python3.3
- Python3.4
- 皮比
- Pypy 3
- Jython
所有其他依赖项都显示在requirements.txt文件中。 附带的makefile可以使用以下命令安装它们:
$ make requirements
安装
该项目作为Pypi package提供,使用pip是首选方法 安装它为此,请使用以下命令;
$ pip install cookiecutter-python-library-demo
如果需要手动安装,项目将包含一个setup.py文件 允许直接安装库的makefile,可以使用 以下命令:
$ make install
用法
应用程序是用python编写的,没有使用任何特定的 框架
协作
任何有关该项目的帮助都会受到欢迎,提供此类帮助的方式主要有两种:
- 通过问题管理报告错误并请求扩展
- 或者分叉存储库并扩展项目
问题管理
问题在githubproject issues tracker中管理,其中任何github 用户可能会报告错误或要求新功能。
获取代码
如果您希望分叉或修改代码,请访问GitHub project page,其中 总是保留最新版本。查看“master”分支的最新版本 发布,以及当前稳定的开发版本的“开发”。
许可证
项目已在MIT License下发布。