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







目录
打赏
0
0
0
0
60
分享
相关文章
|
3月前
|
Python教程:os 与 sys 模块详细用法
os 模块用于与操作系统交互,主要涉及夹操作、路径操作和其他操作。例如,`os.rename()` 重命名文件,`os.mkdir()` 创建文件夹,`os.path.abspath()` 获取文件绝对路径等。sys 模块则用于与 Python 解释器交互,常用功能如 `sys.path` 查看模块搜索路径,`sys.platform` 检测操作系统等。这些模块提供了丰富的工具,便于开发中处理系统和文件相关任务。
117 14
Python文件打包:一站式指南
本文深入探讨Python文件打包的各种方法,从基础的zip和tar工具到高级的setuptools、PyInstaller、cx_Freeze等,涵盖Docker镜像、虚拟环境及自包含可执行文件的打包方式。通过示例代码与详细解析,帮助开发者根据项目需求选择合适的打包方案,提升代码分发与部署效率。内容全面,适合各水平读者学习参考。
204 7
【03】做一个精美的打飞机小游戏,规划游戏项目目录-分门别类所有的资源-库-类-逻辑-打包为可玩的exe-练习python打包为可执行exe-优雅草卓伊凡-持续更新-分享源代码和游戏包供游玩-1.0.2版本
【03】做一个精美的打飞机小游戏,规划游戏项目目录-分门别类所有的资源-库-类-逻辑-打包为可玩的exe-练习python打包为可执行exe-优雅草卓伊凡-持续更新-分享源代码和游戏包供游玩-1.0.2版本
247 31
【03】做一个精美的打飞机小游戏,规划游戏项目目录-分门别类所有的资源-库-类-逻辑-打包为可玩的exe-练习python打包为可执行exe-优雅草卓伊凡-持续更新-分享源代码和游戏包供游玩-1.0.2版本
[oeasy]python070_如何导入模块_导入模块的作用_hello_dunder_双下划线
本文介绍了如何在Python中导入模块及其作用,重点讲解了`__hello__`模块的导入与使用。通过`import`命令可以将外部模块引入当前环境,增强代码功能。例如,导入`__hello__`模块后可输出“Hello world!”。此外,还演示了如何使用`help()`和`dir()`函数查询模块信息,并展示了导入多个模块的方法。最后,通过一个实例,介绍了如何利用`jieba`、`WordCloud`和`matplotlib`模块生成词云图。总结来说,模块是封装好的功能部件,能够简化编程任务并提高效率。未来将探讨如何创建自定义模块。
62 8
|
7月前
|
Python Internet 模块
Python Internet 模块。
183 74
[oeasy]python071_我可以自己做一个模块吗_自定义模块_引入模块_import_diy
本文介绍了 Python 中模块的导入与自定义模块的创建。首先,我们回忆了模块的概念,即封装好功能的部件,并通过导入 `__hello__` 模块实现了输出 "hello world!" 的功能。接着,尝试创建并编辑自己的模块 `my_file.py`,引入 `time` 模块以获取当前时间,并在其中添加自定义输出。
68 5
|
5月前
|
将Python CLI工具发布为pip模块的完整指南
注册PyPI账户 访问PyPI官网注册账户 推荐使用双因素认证增强安全性 生成API令牌 访问PyPI账户管理 生成具有"Upload packages"权限的令牌,妥善保存 确保模块名唯一性 在PyPI搜索页面验证模块名未被使用 建议使用小写字母和连字符的组合(如my-cli-tool)
102 9
马特赛特旋转算法:Python的随机模块背后的力量
马特赛特旋转算法是Python `random`模块的核心,由松本真和西村拓士于1997年提出。它基于线性反馈移位寄存器,具有超长周期和高维均匀性,适用于模拟、密码学等领域。Python中通过设置种子值初始化状态数组,经状态更新和输出提取生成随机数,代码简单高效。
199 63
如何在Python中自动解决模块和包的依赖冲突?
完全自动解决所有依赖冲突可能并不总是可行,特别是在复杂的项目中。有时候仍然需要人工干预和判断。自动解决的方法主要是提供辅助和便捷,但不能完全替代人工的分析和决策😉。
|
6月前
|
[oeasy]python057_如何删除print函数_dunder_builtins_系统内建模块
本文介绍了如何删除Python中的`print`函数,并探讨了系统内建模块`__builtins__`的作用。主要内容包括: 1. **回忆上次内容**:上次提到使用下划线避免命名冲突。 2. **双下划线变量**:解释了双下划线(如`__name__`、`__doc__`、`__builtins__`)是系统定义的标识符,具有特殊含义。
73 3

推荐镜像

更多
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等

登录插画

登录以查看您的控制台资源

管理云资源
状态一览
快捷访问