python如何发布自已pip项目的方法步骤


Posted in Python onOctober 09, 2018

前言

因为自已平时会把一个常用到逻辑写成一个工具python脚本,像关于时间字符串处理,像关于路径和文件夹遍历什么的工具。每一次新建一个项目的时候都要把这些工具程序复制到每个项目中,换一个电脑后还要从github生新下载后再复制到项目中,实在太麻烦。最后想想,还是建一个自已的pip项目会比较好。

环境准备

要用 pip 发布 python 程序,首先当然是要安装 Python 和 pip 这两个软件了,以 Ubuntu 16.04 为例:

$ sudo apt update 
$ sudo apt install -y python python-pip

CentOS 和 RedHat 因为 RPM 体系需要依赖于 python,更是默认就安装好了。

另外发布 Pypi,还需要安装一个发布工具, twine ,以及其所依赖的 setuptools、wheel:

$ sudo pip install --upgrade twine setuptools wheel

好,到这环境就已经就绪了。

第一步:注册一个PyPi帐号

 PyPi注册网站

在上边的注册网站上注册一个自已的帐号,注册好后在邮箱激活,一般注册流程都是这么操作了,这里就不多说了。

第二步:在github上创建一个项目

如果你还没有使用过github源码托管网站,可以先注册一个github的帐户再创建项目,我一般创建项目用的是官网提供的桌面工具Github Desktop.

Github Desktop的下载地址:https://desktop.github.com

github注册和创建新项目,这里也不说了,程序员的基本功。

第三步:编写自已的python项目

我这里只有一个timetool.py和pathtool.py两个文件

详情可以查看我的示例项目: https://github.com/fengmm521/pipProject

先建一个目录,比如magetool,这个里边放的是你的项目代码

在这个magetool目录里,新建一个__init__.py,这个文件里可以什么都不用写,然后就是你要发布的.py文件

第四步:编写setup.py文件

这里重点说明一下这个setup.py文件,因为整个pip项目的发布和上传都是基于这个setup.py文件完成的。

大家可以看一下我示例项目的setup.py是怎么写的,其实我也是从网上下载别人写好的。

#!/usr/bin/env python
#-*- coding:utf-8 -*-

#############################################
# File Name: setup.py
# Author: mage
# Mail: mage@woodcol.com
# Created Time: 2018-1-23 19:17:34
#############################################


from setuptools import setup, find_packages

setup(
  name = "magetool",
  version = "0.1.0",
  keywords = ("pip", "pathtool","timetool", "magetool", "mage"),
  description = "time and path tool",
  long_description = "time and path tool",
  license = "MIT Licence",

  url = "https://github.com/fengmm521/pipProject",
  author = "mage",
  author_email = "mage@woodcol.com",

  packages = find_packages(),
  include_package_data = True,
  platforms = "any",
  install_requires = []
)

setup.py中重要的参数有5个:

1.name

name = “magetool”,这个name参数后边的就是你的项目代码所在目录,也是你pip要上传的项目名称,其他人用pip install xxx来安装时,后边的xxx就是你的这个magetool

2.version

version = “0.1.0”,你工具的版本号,后期你工具更新了,要用pip来更新包的时候,会更新比当前版本号高的新版本。

下边是pip 更新包的命令

pip install --upgrade <包的名字>
pip install -U <包的名字>12

3.packages

packages = find_packages(),这个参数是导入目录下的所有__init__.py包

4.install_requires

install_requires = [],这是一个数组,里边包含的是咱的pip项目引用到的第三方库,如果你的项目有用到第三方库,要在这里添上第三方库的包名,如果用的第三方版本不是最新版本,还要有版本号。

第五步:打包自已的项目

在代码编写完成,自已测试后没有问题了,就可以打包了。

打包使用下边两个命令:

我使用的是第二个

$ python setup.py bdist_egg   # 生成类似 edssdk-0.0.1-py2.7.egg,支持 easy_install 
$ python setup.py sdist     # 生成类似 edssdk-0.0.1.tar.gz,支持 pip12

两个命令打包好之后都会生成build和dist两个目录,打包的文件会放在dist目录下,供后边上传到PyPi服务器

第六步:上传到PyPi服务器

在上传前,要建一个文件,$HOME/.pypirc,$HOME目录在linux或者mac系统下就是~/目录。在这里建一个.pypirc文件。里边的内容如下:

[distutils]
index-servers = pypi

[pypi]
username:你的PyPi用户名
password:你的PyPi密码
~

因为不能使用python setup.py register进行上传,使用这个上传会报一个410的错误。所以要使用.pypirc文件保存你的PyPi用户信息,这时使用下载的twine就可以直接上传了。

在别的地方找到的有说上传用python setup.py sdist upload命令,但在我这里用这个命令也会一直失败,所以我用下边的命令上传打包好的pip项目,我上传的是用第五步的,python setup.py sdist命令打包好的项目,

上传好打包的pip安装包:

twine upload dist/magetool-0.1.0.tar.gz1

第七步:使用pip安装刚刚上传的包

pip安装包我这里就不多说了,这个一般用python的都会的

用pip安装上传的包:

pip install magetool --user

?user参数的意思是安装给当电脑的当前用户,要不然会要求系统管理员权限才能安装。加了?user之后就不用sudo的管理员权限了。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Python中运算符&quot;==&quot;和&quot;is&quot;的详解
Oct 08 Python
python基于pyDes库实现des加密的方法
Apr 29 Python
Python判断两个对象相等的原理
Dec 12 Python
python实现列表中最大最小值输出的示例
Jul 09 Python
Python3离线安装Requests模块问题
Oct 13 Python
DJango的创建和使用详解(默认数据库sqlite3)
Nov 18 Python
PyTorch中permute的用法详解
Dec 30 Python
python实现将两个文件夹合并至另一个文件夹(制作数据集)
Apr 03 Python
PyQt5 文本输入框自动补全QLineEdit的实现示例
May 13 Python
Python调用OpenCV实现图像平滑代码实例
Jun 19 Python
使用keras实现非线性回归(两种加激活函数的方式)
Jul 05 Python
Python OpenCV 图像平移的实现示例
Jun 04 Python
Django csrf 验证问题的实现
Oct 09 #Python
Python正则表达式指南 推荐
Oct 09 #Python
详解Django的CSRF认证实现
Oct 09 #Python
浅析python中的迭代与迭代对象
Oct 08 #Python
实例讲解python中的序列化知识点
Oct 08 #Python
实例讲解python中的协程
Oct 08 #Python
详解python分布式进程
Oct 08 #Python
You might like
德生PL990的分析评价
2021/03/02 无线电
彻底杜绝PHP的session cookie错误
2009/08/09 PHP
PHP的范围解析操作符(::)的含义分析说明
2011/07/03 PHP
php排序算法实例分析
2016/10/17 PHP
PHP的自定义模板引擎
2017/03/24 PHP
thinkphp框架类库扩展操作示例
2019/11/26 PHP
让你的PHP,APACHE,NGINX支持大文件上传
2021/03/09 PHP
js中将具有数字属性名的对象转换为数组
2011/03/06 Javascript
关于Jquery操作Cookie取值错误的解决方法
2013/08/26 Javascript
JavaScript 垃圾回收机制分析
2013/10/10 Javascript
jQuery中die()方法用法实例
2015/01/19 Javascript
vue时间格式化实例代码
2017/06/13 Javascript
JS实现的按钮点击颜色切换功能示例
2017/10/19 Javascript
switchery按钮的使用方法
2017/12/18 Javascript
详解nodejs http请求相关总结
2019/03/31 NodeJs
jQuery删除/清空指定元素的所有子节点实例代码
2019/07/04 jQuery
vue内置组件component--通过is属性动态渲染组件操作
2020/07/28 Javascript
Python合并字符串的3种方法
2015/05/21 Python
Python获取当前路径实现代码
2017/05/08 Python
使用requests库制作Python爬虫
2018/03/25 Python
详解python3中zipfile模块用法
2018/06/18 Python
Python3.5 处理文本txt,删除不需要的行方法
2018/12/10 Python
Python3字符串encode与decode的讲解
2019/04/02 Python
Python实现EXCEL表格的排序功能示例
2019/06/25 Python
python实现网页录音效果
2020/10/26 Python
伊利莎白雅顿官网:Elizabeth Arden
2016/10/10 全球购物
美发店5.1活动方案
2014/01/24 职场文书
入党积极分子自我鉴定范文
2014/03/25 职场文书
学习保证书范文
2014/04/30 职场文书
食品安全承诺书
2014/05/22 职场文书
2014大学生党员评议个人总结
2014/09/22 职场文书
领导班子群众路线与四风问题对照检查材料思想汇报
2014/10/11 职场文书
商铺租房协议书范本
2014/12/04 职场文书
酒店收银员岗位职责
2015/04/07 职场文书
导游词之上海豫园
2019/10/24 职场文书
小米11和iphone12哪个值得买?小米11对比iphone12评测
2021/04/21 数码科技