Python实现在PyPI上发布自定义软件包的方法详解

 更新时间:2022年06月11日 11:15:15   作者:赵卓不凡  
在Python中我们经常使用pip来安装第三方Python软件包,其实我们每个人都可以免费地将自己写的Python包发布到PyPI上。本文我们就将详细介绍如何发布测试包,需要的可以参考一下

1. 引言

在Python中我们经常使用pip来安装第三方Python软件包,其实我们每个人都可以免费地将自己写的Python包发布到PyPI上,供他人来通过pip进行安装。

在本文中,我们将从一步一步地详细介绍如何发布测试包。

2. 创建PyPI账号

网址: https://pypi.org/

我们可以通过上面的链接在PyPI官网免费创建一个帐户。

我们需要先创建一个帐户,然后才能发布测试包。

3. 创建包名

我们可以发布任意我们想要定义的包名,只要和以前发布过的包没有重名过。我们可以快速在网站PyPI上检查是否有同名包。为了方便示例,我们使用aiway来作为示例的包名。

4. 按照如下格式组织包

需要注意的是我们可以使用任意我们想要发布的包名来替换上述aiway包名。

上述脚本 src/aiway/__init__.py内容如下:

def function():
    print("hello from src/aiway/__init__.py")

脚本 src/aiway/test.py内容如下:

def testfunction():
    print("hello from src/aiway/test.py")

脚本LICENSE: 我们这里留白

脚本README.md: 这里可以描述包的用途

脚本pyproject.toml,内容如下:

[build-system]
requires = ["setuptools>=42"]
build-backend = "setuptools.build_meta"

我们必须创建该文件

脚本 setup.py,内容如下:

from time import time
import setuptools
with open("README.md", "r", encoding="utf-8") as fh:
    long_description = fh.read()
setuptools.setup(
    name="aiway",
    version="0.0.0",
    author="Your Name Goes Here",
    author_email="youremail@gmail.com",
    description="A test package",
    long_description=long_description,
    long_description_content_type="text/markdown",
    url="https://github.com/pypa/sampleproject",
    project_urls={
        "Bug Tracker": "https://github.com/pypa/sampleproject/issues",
    },
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    package_dir={"": "src"},
    packages=setuptools.find_packages(where="src"),
    python_requires=">=3.6",
)

5. 安装 Build & Twine

接着我们通过pip来安装我们的依赖包,命令如下:

pip install build twine

我们需要用到上述两个包来将我们的测试包推送到PyPI。安装过程如下:

6. 构建测试包

接着我们来编译我们的测试包,命令如下:

python -m build

在将包上载到PyPI之前,我们需要首先使用build构建它。上述命令的输出如下:

上述命令运行完成后,我们将会得到目录dist 以及 格式为 <package-name>.egg-info的包。如下所示:

7. 上传测试包

接着我们使用以下命令将包上传,如下所示:

python -m twine upload dist/*

包twine用来将我们的测试包上传至PyPI。上述命令执行过程中需要输入我们注册的网站的用户名和密码。如下所示:

同时我们可以在网站上看到我们上传的包,如下:

如果我们只是更新已经存在的包的版本,我们可以使用如下命令:

python -m twine upload dist/* --skip-existing

同时我们可以添加调试标志--verbose,来检查上述命令执行过程中的出错信息,如下:

python -m twine upload dist/* --skip-verbose

8. 总结

本文重点介绍了如何在PyPI上发布自定义软件包的流程,其中每一步都给出了详细的解释和图解。

到此这篇关于Python实现在PyPI上发布自定义软件包的方法详解的文章就介绍到这了,更多相关Python PyPI发布自定义软件包内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 基于python的selenium两种文件上传操作实现详解

    基于python的selenium两种文件上传操作实现详解

    这篇文章主要介绍了基于python的selenium两种文件上传操作实现详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-09-09
  • python备份文件的脚本

    python备份文件的脚本

    作用:将目录备份到其他路径。
    2008-08-08
  • pytest内置fixture使用临时目录流程详解

    pytest内置fixture使用临时目录流程详解

    fixture是在测试函数运行前后,由pytest执行的外壳函数。fixture中的代码可以定制,满足多变的测试需求,包括定义传入测试中的数据集、配置测试前系统的初始状态、为批量测试提供数据源等等。fixture是pytest的精髓所在
    2022-12-12
  • Python中的MongoDB基本操作:连接、查询实例

    Python中的MongoDB基本操作:连接、查询实例

    这篇文章主要介绍了Python中的MongoDB基本操作:连接、查询实例,本文直接给出操作示例代码,需要的朋友可以参考下
    2015-02-02
  • Python Poetrya项目依赖管理安装使用详解

    Python Poetrya项目依赖管理安装使用详解

    这篇文章主要为大家介绍了Python Poetrya项目依赖管理安装使用详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-11-11
  • Python3网络爬虫中的requests高级用法详解

    Python3网络爬虫中的requests高级用法详解

    本节我们再来了解下 Requests 的一些高级用法,如文件上传,代理设置,Cookies 设置等等。感兴趣的朋友跟随小编一起看看吧
    2019-06-06
  • vscode和Anaconda安装以及相关环境配置指南

    vscode和Anaconda安装以及相关环境配置指南

    Anaconda是一个开源的python发行版本,是现在比较流行的python数据科学平台,可以对python的科学包做到有效管理,这篇文章主要给大家介绍了关于vscode和Anaconda安装以及相关环境配置指南的相关资料,需要的朋友可以参考下
    2023-11-11
  • Jupyter Notebook如何导入python文件时的问题

    Jupyter Notebook如何导入python文件时的问题

    这篇文章主要介绍了Jupyter Notebook如何导入python文件时的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07
  • python 生成器需注意的小问题

    python 生成器需注意的小问题

    这篇文章主要介绍了python 生成器需注意的小问题,帮助大家更好的理解和学习python 生成器,感兴趣的朋友可以了解下
    2020-09-09
  • python opencv 画外接矩形框的完整代码

    python opencv 画外接矩形框的完整代码

    这篇文章主要介绍了python-opencv-画外接矩形框的实例代码,代码简单易懂,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-09-09

最新评论