测试开发技术 实战教程:如何将自己的 Python 包发布到 PyPI 上

狂师 · 2020年12月07日 · 444 次阅读

1. PyPi 的用途

Python 中我们经常会用到第三方的包,默认情况下,用到的第三方工具包基本都是从 Pypi.org 里面下载。

我们举个栗子: 如果你希望用 Python 实现一个金融量化分析工具,目前比较好用的金融数据来源是 Yahoo 和 Google。
你可能需要读取这 2 个平台的 API,然后依次实现下载、分析数据的代码。
是不是好麻烦,这样你可以到 PyPi 到上面去找找有没有已经写过这个内容,幸运的是,你真找到了,你找到了一个 package 叫做 yfinance

https://github.com/ranaroussi/yfinance

这个时候你只需要一个命令,免除了我们从头实现的麻烦:

pip install yfinance

就可以了,是不是非常方便。


PyPI 是 Python Package Index 的首字母简写,其实表示的是 Python 的 Packag 索引,这个也是 Python 的官方索引。

需要先再本地环境安装 pip,然后如果要安装其他工具包的话就使用指令:

pip install <package name>

官方地址:https://pypi.org/

一句话解释:如果你使用的是 Java 项目的话,你就将 PyPi 理解成 Maven 就行了。

那我们如何将自己开发的一个包上传到 PyPI,供其它人使用呢。

2.Python 包发布步骤

下面就开始介绍如何将自己的 Python 项目发布到 PyPI

2.1 创建目录结构

创建一个测试项目,例如project_demo,在该项目下,创建一个待发布的包目录,例如:package_mikezhou_talk,并在该project_demo目录下,依次创建:setup.pyLICENSEREADME.rst几项文件,此时目录结构为:

➜  project_demo tree -L 2
.
├── LICENSE
├── README.rst
├── package_mikezhou_talk
│   └── __init__.py
└── setup.py

1 directory, 4 files

2.2 准备文件

接下来我们来逐一编写除了代码以外的文件。

1、README.rst
是关于项目的描述文件,一般包含怎样安装项目,怎样使用项目等。markdown 语法可以参考 https://rest-sphinx-memo.readthedocs.io/en/latest/ReST.html

打开 README.rst 并输入以下内容。可以自定义此项,放入一些对项目的介绍。

# Example Package
This is a simple example package. You can use

[联系作者](https://mp.weixin.qq.com/s/9FQ-Tun5FbpBepBAsdY62w)

to write your content.

2、LICENSE.txt,创建许可证

上传到 Python Package Index 的每个包都包含许可证,这一点很重要。这告诉用户安装你的软件包可以使用您的软件包的条款。
开源 License,有如 MIT,Apache license 2.0 等。有关选择许可证的帮助,请访问https://choosealicense.com/。选择许可证后,打开 LICENSE 并输入许可证文本。

3、setup.py 文件

setup.py 是 setuptools 的构建脚本,用来描述项目,打包的时候会用到这个文件。它告诉 PyPI 我们的项目叫什么名字,是什么版本,依赖哪些库,支持哪些操作系统,可以在哪些版本的 Python 上运行,等等。

标准脚本示例:

from distutils.core import setup
from setuptools import find_packages

with open("README.rst", "r") as f:
  long_description = f.read()

setup(name='package_mikezhou_talk',  # 包名
      version='1.0.0',  # 版本号
      description='A small example package',
      long_description=long_description,
      author='mikezhou_talk',
      author_email='762357658@qq.com',
      url='https://mp.weixin.qq.com/s/9FQ-Tun5FbpBepBAsdY62w',
      install_requires=[],
      license='BSD License',
      packages=find_packages(),
      platforms=["all"],
      classifiers=[
          'Intended Audience :: Developers',
          'Operating System :: OS Independent',
          'Natural Language :: Chinese (Simplified)',
          'Programming Language :: Python',
          'Programming Language :: Python :: 2',
          'Programming Language :: Python :: 2.7',
          'Programming Language :: Python :: 3',
          'Programming Language :: Python :: 3.5',
          'Programming Language :: Python :: 3.6',
          'Programming Language :: Python :: 3.7',
          'Programming Language :: Python :: 3.8',
          'Topic :: Software Development :: Libraries'
      ],
      )

重要参数说明:

  • name:项目的名称,name 是包的分发名称。
  • version:项目的版本。需要注意的是,PyPI 上只允许一个版本存在,如果后续代码有了任何更改,再次上传需要增加版本号
  • author 和 author_email:项目作者的名字和邮件, 用于识别包的作者。
  • description:项目的简短描述
  • long_description:项目的详细描述,会显示在 PyPI 的项目描述页面。必须是 rst(reStructuredText) 格式的
  • packages:指定最终发布的包中要包含的 packages。
  • install_requires:项目依赖哪些库,这些库会在 pip install 的时候自动安装
  • classifiers:其他信息,一般包括项目支持的 Python 版本,License,支持的操作系统。

克隆 setup.py 仓库(推荐)

如果你觉得手写setup.py脚本文件难度大太,给你推荐另外一个简易方法。

大名鼎鼎的 requests 库的作者大神 kennethreitz 为大家准备了一个仓库作为一个 setup.py 的很好的模板,当然你也可以自己手写 setup.py。

git clone  https://github.com/kennethreitz/setup.py

建议大家直接编辑之前的仓库里的 setup.py, 只需要修改一些必要的配置就可以了。

2.3 编写核心代码

接下来我们就可以编写自己的代码了,要注意源代码文件夹(仓库里的package_mikezhou_talk包目录)的名字与 setup.py 里配置的包名(Name)要一致。

这一部内容,就根据各自的需求,自行实现即可。
例如:我在示例package_mikezhou_talk包目录下,新建了一个 main.py 文件,在该文件下实现待实现的功能。

示例:

import itertools

case_list = ['用户名', '密码']
value_list = ['正确', '不正确', '特殊符号', '超过最大长度']


def gen_case(item=case_list, value=value_list):
    '''输出笛卡尔用例集合'''
    for i in itertools.product(item, value):
        print('输入'.join(i))

def test_print():
        print("欢迎搜索关注公众号: 「测试开发技术」!")

if __name__ == '__main__':
    test_print()

2.4 生成分发档案

下一步是为包生成分发包。这些是上传到包索引的档案,可以通过 pip 安装。

确保您拥有 setuptools 并 wheel 安装了最新版本:

python3 -m pip install --user --upgrade setuptools wheel

生成这前,可以先运行python setup.py check检查 setup.py 是否有错误,如果没报错误,则进行下一步输出一般是 running check。

1、准备好上面的步骤, 一个包就基本完整了, 剩下的就是打包了,可以使用下面命令打包一个源代码的包:

python setup.py sdist build

这样在当前目录的 dist 文件夹下, 就会多出一个 tar.gz 结尾的包了:

2、也可以打包一个 wheels 格式的包, 使用下面的命令就可以了:

python setup.py bdist_wheel --universal

这样会在 dist 文件夹下面生成一个 whl 文件.

3、或者从 setup.py 位于的同一目录运行此命令:

python3 setup.py sdist bdist_wheel

上面的命令会在 dist 目录下生成一个 tar.gz 的源码包和一个.whl 的 Wheel 包。

2.5 发布包到 PyPi

1、接下来就是去https://pypi.org/account/register/注册账号,如果有账号的请忽略,记住你的账号和密码,后面上传包会使用。

2、接下来就是上传你的包了,这里使用 twine 上传。
需要先安装 twine(用 twine 上传分发包,并且只有 twine> = 1.11.0 才能将元数据正确发送到 Pypi 上)

pip install twine

3、安装完之后,运行下面的命令将库上传,上传包,期间会让你输入注册的用户名和密码

twine upload dist/*

输入 PyPI 注册的用户名和密码。命令完成后,您应该看到与此类似的输出:

➜  twine upload dist/*
Uploading distributions to https://upload.pypi.org/legacy/
Enter your username: mikezhou_talk
Enter your password:
Uploading package_mikezhou_talk-1.0.0-py3-none-any.whl
100%|██████████████████████████████████████| 7.84k/7.84k [00:03<00:00, 2.29kB/s]
Uploading package_mikezhou_talk-1.0.0.tar.gz
100%|██████████████████████████████████████| 6.64k/6.64k [00:01<00:00, 6.05kB/s]

View at:
https://pypi.org/project/package-mikezhou-talk/1.0.0/

上传完成后,我们的项目就成功地发布到 PyPI 了。

3.验证发布 PYPI 成功

上传完成了会显示 success,我们直接可以在 PyPI 上查看,如下:


您可以使用 pip 来安装包并验证它是否有效。 创建一个新的 virtualenv(请参阅安装包以获取详细说明)并从 TestPyPI 安装包:

python3 -m pip install --index-url https://test.pypi.org/simple/ package-mikezhou-talk
或
pip install package-mikezhou-talk -i https://www.pypi.org/simple/

如下图所示:

进入 Python Shell 验证结果如下:

至此,我们已经成功地将自己开发的 Python 程序发布到了 PyPI,此时你,可以直接在你本地的环境通过 pip 命令安装示例中的package-mikezhou-talk这个包了。

官网地址:

https://pypi.org/project/package-mikezhou-talk/1.0.0/
如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!
暂无回复。
需要 登录 后方可回复, 如果你还没有账号请点击这里 注册