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实现实时监控文件的方法
Aug 26 Python
Python的爬虫框架scrapy用21行代码写一个爬虫
Apr 24 Python
Python爬虫获取整个站点中的所有外部链接代码示例
Dec 26 Python
Django自定义过滤器定义与用法示例
Mar 22 Python
Python多重继承的方法解析执行顺序实例分析
May 26 Python
Python基于分析Ajax请求实现抓取今日头条街拍图集功能示例
Jul 19 Python
Python3 jupyter notebook 服务器搭建过程
Nov 30 Python
Python代理IP爬虫的新手使用教程
Sep 05 Python
python常见字符串处理函数与用法汇总
Oct 30 Python
Python字节单位转换实例
Dec 05 Python
详解解Django 多对多表关系的三种创建方式
Aug 23 Python
Python FuzzyWuzzy实现模糊匹配
Apr 28 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
php可生成缩略图的文件上传类实例
2014/12/17 PHP
基于linnux+phantomjs实现生成图片格式的网页快照
2015/04/15 PHP
使用WordPress发送电子邮件的相关PHP函数用法解析
2015/12/15 PHP
PHP对象实例化单例方法
2017/01/19 PHP
js中各种类型的变量在if条件中是true还是false
2014/07/16 Javascript
wap图片滚动特效无css3元素纯js脚本编写
2014/08/22 Javascript
js+html5通过canvas指定开始和结束点绘制线条的方法
2015/06/05 Javascript
JavaScript 经典实例日常收集整理(常用经典)
2016/03/30 Javascript
基于Jquery插件实现跨域异步上传文件功能
2016/04/26 Javascript
Javascript将双字节字符转换成单字节字符并计算长度
2016/06/22 Javascript
AngularJS中directive指令使用之事件绑定与指令交互用法示例
2016/11/22 Javascript
js仿新浪微博消息发布功能
2017/02/17 Javascript
Vue.js中的图片引用路径的方式
2017/07/28 Javascript
ES6中数组array新增方法实例总结
2017/11/07 Javascript
微信小程序三级联动选择器使用方法
2020/05/19 Javascript
详解关于微信setData回调函数中的坑
2019/02/18 Javascript
微信小程序常见页面跳转操作简单示例
2019/05/01 Javascript
[59:35]DOTA2-DPC中国联赛定级赛 Aster vs DLG BO3第一场 1月8日
2021/03/11 DOTA
python基于socket实现网络广播的方法
2015/04/29 Python
python中的tcp示例详解
2018/12/09 Python
Python学习笔记之迭代器和生成器用法实例详解
2019/08/08 Python
Python 使用多属性来进行排序
2019/09/01 Python
Python run()函数和start()函数的比较和差别介绍
2020/05/03 Python
Python计算矩阵的和积的实例详解
2020/09/10 Python
CSS3改变浏览器滚动条样式
2019/01/04 HTML / CSS
html5自动播放mov格式视频的实例代码
2020/01/14 HTML / CSS
联想香港官方网站及网店:Lenovo香港
2018/04/13 全球购物
建筑实习自我鉴定
2013/10/18 职场文书
公司端午节活动方案
2014/02/04 职场文书
缓刑期间思想汇报范文
2014/10/10 职场文书
因身体原因离职的辞职信范文
2015/05/12 职场文书
2015年除四害工作总结
2015/07/23 职场文书
机关单位2016年创先争优活动总结
2016/04/05 职场文书
python opencv将多个图放在一个窗口的实例详解
2022/02/28 Python
Python如何快速找到多个字典中的公共键(key)
2022/04/29 Python
Android学习之BottomSheetDialog组件的使用
2022/06/21 Java/Android