使用pip发布Python程序的方法步骤


Posted in Python onOctober 11, 2018

写过 Python 程序的小伙伴们都知道,需要 import 个非 Python 自带的软件包时,都要用到 pip 这个程序。平时我们都是用 pip,如果我们写好了一个程序,想让大家都能用的到,那么是不是也可以通过 pip 发布出去呢?

答案当然是可以了,这篇文章我们就来看看如何用 pip 发布一个 python 程序。

1. 环境准备

要用 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

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

2. 注册帐号

pip 上传代码包是最终保存在 https://pypi.org 这个网站上的,所以要用 pip 发布程序,就需要在这个网站上注册一个帐号。

访问该网址进行注册: https://pypi.org/account/register/

使用pip发布Python程序的方法步骤

注册后还需要进行邮箱验证,流程和普通网站没有任何区别,所以具体步骤就不在这里详细介绍了。

3. 代码结构

要发布 Python 程序,程序的结构必须符合特定的要求,假设要发布的程序名为 example-pkg,基本的目录结构如下:

/example-pkg
 /example-pkg
  __init__.py
 setup.py
 LICENSE
 README.md

说一下目录和文件的含义:

  • 首先最外层要建立一个和发出程序同名的文件夹: /example-pkg
  • 该文件夹下还要再简历一个同名文件夹,用来存放程序代码: /example-pkg/example-pkg
  • Python 的老规矩,example-pkg/example-pkg 目录下当然要有一个 __init__.py 文件。
  • /example-pkg 目录下要有一个叫 setup.py 的文件,如果下载过 Python 代码包,应该都知道这个文件,需要通过这个文件进行 Python 代码的编译(可能会有依赖的其他代码包或者依赖的 C 文件)和安装。
  • LICENSE 文件:这个文件就是用来保存代码所使用的开源许可证。
  • README.md:这个是软件行业的惯例了,帮助文档。

对于 setup.py 文件,还有必要好好说说,先贴个例子,下面这个例子中,主要是实现了从 /example-pkg/example-pkg/__init__.py 文件中读取 version 参数,来配置当前软件的版本,并指定了代码包名(name)、作者(author)、邮箱(author_email)、描述信息(long_description、long_description_content_type)、依赖(install_requires),以及哪些文件不会被打包到程序中(exclude_package_data)。

另外需要提醒大家一点, 给程序起名字不要带下划线(_) ,python import 代码包时,是不支持下划线包名的,出现这种情况就比较尴尬,代码装上了,还是用不了。

#!/usr/bin/env python

import re
import setuptools

version = ""
with open('example-pkg/__init__.py', 'r') as fd:
  version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]',
            fd.read(), re.MULTILINE).group(1)

with open("README.md", "r") as fh:
  long_description = fh.read()

setuptools.setup(
  name="example-pkg",
  version=version,
  author="example",
  author_email="author@example.com",
  description="This is the SDK for example.",
  long_description=long_description,
  long_description_content_type="text/markdown",
  url="http://example.com",
  install_requires=[
    'requests!=2.9.0',
    'lxml>=4.2.3',
    'monotonic>=1.5',
  ],
  packages=setuptools.find_packages(exclude=("test")),
  classifiers=(
    "License :: OSI Approved :: MIT License",
    "Intended Audience :: Developers",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
    "Programming Language :: Python :: 2",
    "Programming Language :: Python :: 2.6",
    "Programming Language :: Python :: 2.7",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.3",
    "Programming Language :: Python :: 3.4",
    "Programming Language :: Python :: 3.5"
  ),
  exclude_package_data={'': ["example-pkg/test.py", "example-pkg/config.txt"]},
)

4. 上传和检查

一切准备就绪,下面就可以执行打包命令,产生要上传的代码包了:

$ python setup.py sdist bdist_wheel

执行结束后,会产生如下目录和文件:

/example-pkg/dist/
 example-pkg-0.0.1-py3-none-any.whl
 example-pkg-0.0.1.tar.gz

包有了,就差上传了,执行第一步中安装的 twine 命令:

$ twine upload dist/*
Uploading distributions to https://upload.pypi.org/legacy/
Enter your username: <your pypi.org username>
Enter your password: <your pypi.org password>
Uploading example-pkg-0.0.1-py3-none-any.whl
100%|?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????| 45.0k/45.0k [00:01<00:00, 24.0kB/s]
Uploading example-pkg-0.0.1.tar.gz
100%|?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????| 43.8k/43.8k [00:00<00:00, 46.2kB/s]

上传完毕!不过这里有一点需要注意,上传新版本后,很可能 pip search 还没法查到版本的更新,这是正常的,我理解是

pip search 命令依赖于缓存,所以不会立刻生效。

接下来就让我们下载自己刚刚上传的 python 试试吧:

$ pip install example-pkg
$ python
>>> import example-pkg
>>> example-pkg.name
'example-pkg'

最后再补充一点,上传可能会失败,提示无法上传指定的代码包,此时很大的可能是 pypi 中已经有了相同的代码包,所以建议在上传之前,先搜索一下是否有重名的代码包,选择一个不冲突的名字,再上传。

例如下面这个例子,example-pkg 已经存在了,如果要再上传,那当然会失败,换个名字就解决了。

$ pip search example-pkg
example-pkg (0.0.7)                      - A small example package
......

5. 参考文档

Packaging Python Projects

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

Python 相关文章推荐
Python获取远程文件大小的函数代码分享
May 13 Python
在Python中操作字典之update()方法的使用
May 22 Python
python实现的DES加密算法和3DES加密算法实例
Jun 03 Python
Python聚类算法之凝聚层次聚类实例分析
Nov 20 Python
python下读取公私钥做加解密实例详解
Mar 29 Python
Python判断变量是否为Json格式的字符串示例
May 03 Python
django ajax json的实例代码
May 29 Python
解决pandas使用read_csv()读取文件遇到的问题
Jun 15 Python
pyqt5 实现 下拉菜单 + 打开文件的示例代码
Jun 20 Python
PyQt5多线程刷新界面防假死示例
Dec 13 Python
python读取Kafka实例
Dec 23 Python
Python多线程thread及模块使用实例
Apr 28 Python
对python Tkinter Text的用法详解
Oct 11 #Python
python数据批量写入ScrolledText的优化方法
Oct 11 #Python
攻击者是如何将PHP Phar包伪装成图像以绕过文件类型检测的(推荐)
Oct 11 #Python
python中join()方法介绍
Oct 11 #Python
Python中staticmethod和classmethod的作用与区别
Oct 11 #Python
对Python 窗体(tkinter)文本编辑器(Text)详解
Oct 11 #Python
详谈Python 窗体(tkinter)表格数据(Treeview)
Oct 11 #Python
You might like
Codeigniter发送邮件的方法
2015/03/19 PHP
启用Csrf后POST数据时出现的400错误
2015/07/05 PHP
WordPress中用于更新伪静态规则的PHP代码实例讲解
2015/12/18 PHP
PHPExcel中文帮助手册|PHPExcel使用方法(分享)
2017/06/09 PHP
解决php extension 加载顺序问题
2019/08/16 PHP
js下弹出窗口的变通
2007/04/18 Javascript
javascript循环变量注册dom事件 之强大的闭包
2010/09/08 Javascript
Javascript中的方法链(Method Chaining)介绍
2015/03/15 Javascript
js动态生成form 并用ajax方式提交的实现方法
2016/09/09 Javascript
javascript过滤数组重复元素的实现方法
2017/05/03 Javascript
JavaScript生成图形验证码
2020/08/24 Javascript
JS 中可以提升幸福度的小技巧(可以识别更多另类写法)
2018/07/28 Javascript
对Vue table 动态表格td可编辑的方法详解
2018/08/28 Javascript
js计算两个日期间的天数月的实例代码
2018/09/20 Javascript
微信小程序实现的点击按钮 弹出底部上拉菜单功能示例
2018/12/20 Javascript
vue 父组件给子组件传值子组件给父组件传值的实例代码
2019/04/15 Javascript
[01:38]完美世界高校联赛决赛花絮
2018/12/02 DOTA
使用cx_freeze把python打包exe示例
2014/01/24 Python
python实现将文本转换成语音的方法
2015/05/28 Python
django ajax发送post请求的两种方法
2020/01/05 Python
python求最大公约数和最小公倍数的简单方法
2020/02/13 Python
python数据预处理方式 :数据降维
2020/02/24 Python
Python如何在循环内使用list.remove()
2020/06/01 Python
Python变量及数据类型用法原理汇总
2020/08/06 Python
一篇文章搞懂python的转义字符及用法
2020/09/03 Python
Gap加拿大官网:Gap Canada
2017/08/24 全球购物
荷兰街头时尚之家:Funkie House
2019/03/18 全球购物
在weblogic中发布ejb需涉及到哪些配置文件
2012/01/17 面试题
Java程序员面试题
2016/09/27 面试题
学校文明单位申报材料
2014/05/06 职场文书
卖车协议书范例
2014/09/16 职场文书
四查四看整改措施
2014/09/19 职场文书
工作年限证明模板
2014/11/01 职场文书
2015年乡镇卫生院妇幼保健工作总结
2015/05/19 职场文书
导游词之安徽九华山
2019/09/18 职场文书
2019年共青团工作条例最新版
2019/11/12 职场文书