pypi模板库。

pypi-template的Python项目详细描述


PYPI模板

My take at a template repository that I can fork for every Python project I want to push to PyPi

Latest Version on PyPISupported ImplementationsBuild StatusDocumentation StatusCoverage StatusBuilt with PyPi Template

如何,执行摘要

  1. 叉开它
  2. 重命名它
  3. 编辑它
  4. 扩展它
  5. 使用它

开始

分叉和重命名是使用此存储库的前两个步骤。它们都是您在github执行的操作,但是…

不带叉的叉……

您不必经历github的分叉概念,从命令行执行所有操作……

$ git clone https://github.com/christophevg/pypi-template
$ mv pypi-template your-new-project
$ cd your-new-project
$ git remote remove origin
$ git remote add origin git@github.com:your-account/your-new-project.git
$ git push -u master origin

使用命令行

存储库还包括一个小脚本,用于从存储库的克隆复制文件。如果安装该模块,脚本将在您的路径中注册,并允许

$ pip install pypi-template

$ mkdir my-new-project
$ cd my-new-project

$ pypi-template

$ ls -la
total 40
drwxr-xr-x  11 xtof  staff   352 Nov 1121:34 .
drwxr-xr-x  46 xtof  staff  1472 Nov 1121:10 ..
drwxr-xr-x   3 xtof  staff    96 Nov 1121:35 .github
-rw-r--r--   1 xtof  staff   144 Nov 1121:31 .travis.yml
-rw-r--r--   1 xtof  staff  1067 Nov 1121:34 LICENSE.txt
-rw-r--r--   1 xtof  staff   443 Nov 1121:34 Makefile
drwxr-xr-x   6 xtof  staff   192 Nov 1121:35 docs
drwxr-xr-x   3 xtof  staff    96 Nov 1121:35 pypi_template
-rw-r--r--   1 xtof  staff  1830 Nov 1121:34 setup.py
drwxr-xr-x   3 xtof  staff    96 Nov 1121:35 tests
-rw-r--r--   1 xtof  staff   167 Nov 1121:34 tox.ini

脚本只复制不存在的文件,因此它也可以用来升级到PyPI模板的新版本,并基于添加的文件夹导入新的特征。对于现有文件的更改,稍后将添加更详细的复制函数;-()

要编辑的内容

  1. 模块顶层文件夹

有一个占位符顶级模块文件夹。你可能想把它改名。

$ mv pypi_template your_new_project
  1. license.txt

把许可证换成你觉得合适的。

  1. .github/readme.md

将此信息替换为有关项目的信息。

  1. setup.py

将python包配置替换为适合您的项目的配置。

  1. 文档/

docs/包含此自述文件的副本,作为可发布到ReadTheDocs的其他文档的占位符。编辑conf.py以反映项目的名称和说明。

要做的事情

测试

已准备好基本测试设置。要在本地运行,请发出…

$ make test
...
___________________________________ summary ____________________________________
  py27: commands succeeded
  congratulations :)

前往https://travis-ci.org并注册您的项目。还提供了基本的ci配置。

转到https://coveralls.io并注册您的项目以咨询您的代码覆盖率报告。

生成/发布文档

$ make docs

这将生成docs/的html版本并在浏览器中打开它。

如果要将文档(从docs/文件夹)发布到例如ReadTheDocs的文件夹中,请同时导入那边的存储库。

发布到pypi

https://test.pypi.org注册一个帐户。下一个简单的问题…

$ make publish-test

将模块发布到pypi的测试实例。

$ make publish

将模块发布到PyPi的主实例。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
使用jaxrpc的Java eclipse WebService客户端   java编程方式在对象上写入名称   java Spring批处理:重试后跳过   java Android错误:错误:任务执行失败:应用程序:transformClassesWithDexForDebug'   带有清单文件nullPointerException的java Android元数据   spring Java Quartz调度作业停止运行   JavaMockito:如何在不调用实际方法的情况下,模拟带有参数和无效返回类型的静态方法?   java Tomcat连接池问题无法在关闭的连接上调用方法   java如何交换列表中的项目?   java如何停止线程并通过Toast在线程中正确显示文本?   java为什么连续写入OutputStream时偏移量0不会导致重复字节?   java我无法生成头文件   不兼容的返回类型错误java   修改值后键值对的java Jolt转换规范   java有自动更新Javadoc的工具吗?   java线程如何在ints自身实例类中共享变量   java继承一个非gwt模块   java Hibernate xml配置   使用netty4异步调用的java链接HTTP请求响应