python|如何将编写的模块打包上传至pypi

简介: python|如何将编写的模块打包上传至pypi

我们此前花了很大功夫写了一个极其简单的web框架myWeb,想要给别人用的时候,需要让别人拷贝源代码才行,这太low了,所以本篇文章会介绍如何将自己写的模块打包上传至pypi。以便让需要的人通过pip进行安装。


本文所依赖的环境为:

image.png


这里你可能会好奇,为啥和之前版本不一样了呢?因为我在学习打包的时候,发现我们此前的python 3.68只支持到Setuptools 59.6.0,没办法安装到Setuptools 61.0,所以我重新源码安装了一下python 3.7。 如果你和我一样,是在centos 7上面学习的,注意也要升级一下python版本哦!


这里还有一点需要注意,如果我们是第一次将python进行打包上传到pypi或者说只是为了测试,建议一开始不直接上传pypi.org,而是上传至test.pypi.org,这是python提供的一个测试系统,环境和pypi.org一致,所以,我们本篇文章所上传的库为test.pypi.org


什么是pypi


python除了系统默认模块,如osretime等等,还有众多的第三方模块,如大名鼎鼎的flaskwsgiref等等。


我们通常想要使用第三方模块的时候,需要先使用pip进行安装,例如:

pip3 install flask

这个命令,会向软件存储库下载第三方模块包,这个软件存储库就是Pypi也称之为包索引。默认如果不指定源,则会向 pypi.org/ ,也可以在pip中使用-i选项指定源,例如清华pypi源等等。


用一句话概括,pypi就是存储python开发者编写的第三方模块的地方。


此外还有众多的源,如果不是作为私有库的话,几乎都是同步的python官方pypi



注册pypi


如果你想注册真实的pypi,则使用的url为: pypi.org/account/reg…

这里还是要提醒,请不要将测试的项目上传至pypi,那样对使用者很不友好。

打开pypi注册页面,填上电子邮件等信息,进行注册,pypi注册网址: test.pypi.org/account/reg…

image.png

填写完毕后,点击【Create account】即可创建账号。而后pypi会给注册的邮箱发送一个校验url,点击后,即可注册成功。


注册成功后,我们需要生成token用于上传pypi,注册成功登录后,需要从用户名点击,选择【Account Settings】

image.png


往下滑,找到【API tokens】


image.png


点击后,输入Token名称,和选择Token范围

image.png


完成后,点击【Add token】 就可以了。

image.png


完成后,会得到一个很长的以pypi-开头的token请记住它,后面要用

至此,注册pypi,生成token已经结束了。




python打包格式


这里我将整个目录都放到了gitee上,相关格式的话,可以看一下,地址: gitee.com/pdudo/golea…

在进行打包之前,我们需要创建符合pypi包格式的文件,其包的格式为:

image.png

其中,目录和文件的含义分别为:

  • LICENSE: 包的许可证。
  • pyproject.toml: python项目配置文件。
  • README.md:项目说明文件。
  • src: 存放源码的目录。
  • src.juejinPdudoSampleWeb:是一个目录,包名为: juejinPdudoSampleWeb
  • src.juejinPdudoSampleWeb.*:python源文件,注意__init__.py为入口文件,可以为空。
  • tests:测试程序目录。


在该目录下,pyproject.toml尤其重要,这里贴一下我们本次打包文件的内容为:

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"
[project]
name = "JuejinPdudoProject"
version = "0.0.2"
authors = [
  { name="pdudo", email="1052558+pdudo@user.noreply.gitee.com" },
]
description = "A simple WSGI-compliant web application layer framework"
readme = "README.md"
requires-python = ">=3.7"
classifiers = [
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: MIT License",
]
[project.urls]
"Homepage" = "https://gitee.com/pdudo/golearn/blob/master/python/PackagingTesting"
"Bug Tracker" = "https://gitee.com/pdudo/golearn/issues"


其中,有三个大项,分为为:

  • build-system:包的依赖环境。
  • project:项目内容。
  • project.urls:项目URL

build-system是构建包所需的列表信息。


project下,其中nameversionauthorsdescription是包的基本信息,包括名称、版本、作者 以及 包的简介等。


readme是指定项目的说明文件,一般而言是README.mdrequires-python是该包所依赖的python版本,classifierspython包的元数据。


最后是project.urls,它将在pypi上显示输入的额外链接。



打包上传至pypi


如果将pypi包的格式做好了,那么恭喜你,就可以开始打包了,在进行正式打包之前,我们需要安装相关依赖:


基本工具安装

安装打包工具build

pip3 install build


安装上传工具twine

如果只想打包,不想上传至pypi,可以不安装此工具。

pip3 install twine



如果网络很差的时候,可以考虑下使用第三方源,例如清华,安装build命令为:

pip3 install build -i https://pypi.tuna.tsinghua.edu.cn/simple



使用build进行打包


开始打包的时候,需要进入JuejinPdudoProject,和pyproject.toml处于同一目录,使用如下命令进行打包:

python3 -m build

在此过程中,它会常见虚拟环境,安装构建依赖,而后开始按照文件内容,进行打包。

如果成功的话,会出现Successfully built juejinPdudoProject-0.0.2.tar.gz and juejinPdudoProject-0.0.2-py3-none-any.whl类似的信息:

image.png

如果此时我们再使用tree命令查看当前目录下结构:

image.png

我们会发现,此时多了一个目录dist,里面正是我们打包的包。




使用twine上传至pypi


在当前目录下,使用命令

python3 -m twine upload --repository testpypi dist/* --verbose

就可以将包上传至pypi了,在此过程中,会让我们输入用户名和密码,还记得我们注册pypi的时候生成过一个API tokens,上传的时候会用到此信息。

image.png

这个就证明上传pypi成功了。此时再打开页面,就可以看到相关内容了:

此时打开pypi网页,就可以看到我们创建的项目了:


image.png




从pypi下载包测试代码


这里,我们根据网站提示下载包:

image.png


我们这次在windows终端下安装该包:

image.png


安装完毕后,再编写一个简单的测试代码

image.png

在浏览器进行测试后,可得

image.png


由此证明上传的包没有问题。



总结


本篇文章介绍了什么是pypi,以及打包的格式,最后打包完毕后,将包上传至pypi。这里有几个细节可以注意一下,当我们打包后,会得到一个dist目录,在该目录下,有一个结尾为.whl的文件,我们可以直接通过pip install 跟上文件名来安装一下包,若包没问题后,我们就可以上传到pypi了。还有pypi有一个很严格的措施,为了安全,pypi不允许重复使用项目,即使该项目被删除了并再次上传也不行,这是要方式项目被恶意更改,所以删除就再也不存在该项目了,还有一点,如果只是测试上传pypi,请使用test.pypi.org







相关文章
|
1天前
|
关系型数据库 数据处理 数据库
Python中的异步编程:理解asyncio模块及其应用
在现代编程中,异步编程变得越来越重要。Python中的asyncio模块为开发者提供了强大的工具,帮助他们利用异步编程模式来处理高并发和IO密集型任务。本文将深入探讨asyncio模块的核心概念、基本用法以及实际应用场景,帮助读者更好地理解和运用Python中的异步编程技术。
|
1天前
|
开发者 Python
确保你的Python环境中已经安装了`python-docx`模块。如果还没有安装,可以通过pip来安装:
确保你的Python环境中已经安装了`python-docx`模块。如果还没有安装,可以通过pip来安装:
8 1
|
1天前
|
资源调度 计算机视觉 Python
`scipy.ndimage`是SciPy库中的一个子模块,它提供了许多用于处理n维数组(通常是图像)的函数。
`scipy.ndimage`是SciPy库中的一个子模块,它提供了许多用于处理n维数组(通常是图像)的函数。
7 0
|
1天前
|
Python
`scipy.signal`模块是SciPy库中的一个子模块,它提供了信号处理、滤波、频谱分析等功能。这个模块包含了许多用于信号处理的函数和类,其中`butter()`和`filtfilt()`是两个常用的函数。
`scipy.signal`模块是SciPy库中的一个子模块,它提供了信号处理、滤波、频谱分析等功能。这个模块包含了许多用于信号处理的函数和类,其中`butter()`和`filtfilt()`是两个常用的函数。
10 0
|
1天前
|
数据可视化 Python
时间序列分析是一种统计方法,用于分析随时间变化的数据序列。在金融、经济学、气象学等领域,时间序列分析被广泛用于预测未来趋势、检测异常值、理解周期性模式等。在Python中,`statsmodels`模块是一个强大的工具,用于执行各种时间序列分析任务。
时间序列分析是一种统计方法,用于分析随时间变化的数据序列。在金融、经济学、气象学等领域,时间序列分析被广泛用于预测未来趋势、检测异常值、理解周期性模式等。在Python中,`statsmodels`模块是一个强大的工具,用于执行各种时间序列分析任务。
7 0
|
1天前
|
API Python
首先,我们导入了`http.client`模块,它是Python标准库中的一个模块,用于创建和发送HTTP请求。
首先,我们导入了`http.client`模块,它是Python标准库中的一个模块,用于创建和发送HTTP请求。
5 0
|
1天前
|
存储 SQL Python
`urllib.parse`模块是Python标准库`urllib`中的一个子模块,它提供了处理URL(统一资源定位符)的实用功能。这些功能包括解析URL、组合URL、转义URL中的特殊字符等。
`urllib.parse`模块是Python标准库`urllib`中的一个子模块,它提供了处理URL(统一资源定位符)的实用功能。这些功能包括解析URL、组合URL、转义URL中的特殊字符等。
5 0
|
1天前
|
网络协议 Python
在Python中,我们使用`socket`模块来进行网络通信。首先,我们需要导入这个模块。
在Python中,我们使用`socket`模块来进行网络通信。首先,我们需要导入这个模块。
4 0
|
1天前
|
Unix Linux Python
`subprocess`模块是Python中用于生成新进程、连接到它们的输入/输出/错误管道,并获取它们的返回(退出)代码的模块。
`subprocess`模块是Python中用于生成新进程、连接到它们的输入/输出/错误管道,并获取它们的返回(退出)代码的模块。
6 0
|
1天前
|
Python
在Python中,`multiprocessing`模块提供了一种在多个进程之间共享数据和同步的机制。
在Python中,`multiprocessing`模块提供了一种在多个进程之间共享数据和同步的机制。
4 0