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跨平台路径格式不一致的处理方法

    Python跨平台路径格式不一致的处理方法

    你是不是也遇到过 Python 跨平台路径格式不一致的问题?在 Windows、macOS 和 Linux 之间切换时,路径格式的不同简直让人头疼,今天,我们就来彻底解决这个问题,并告诉你在实际开发和打包时,哪种方法更好用,需要的朋友跟着小编一起来看看吧
    2025-04-04
  • 如何基于Python深度图生成3D点云详解

    如何基于Python深度图生成3D点云详解

    通常使用TOF等3d摄像头采集的格式一般只是深度图,下面这篇文章主要给大家介绍了关于如何基于Python深度图生成3D点云的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2022-12-12
  • python3 正则表达式基础廖雪峰

    python3 正则表达式基础廖雪峰

    正则表达式是一种用来匹配字符串的强有力的武器。它的设计思想是用一种描述性的语言来给字符串定义一个规则,凡是符合规则的字符串,我们就认为它“匹配”了,否则,该字符串就是不合法的
    2020-03-03
  • 浅析python 字典嵌套

    浅析python 字典嵌套

    这篇文章主要介绍了python 字典嵌套的相关资料,帮助大家更好的理解和学习python,感兴趣的朋友可以了解下
    2020-09-09
  • 基于Python实现绘制简单动图的示例详解

    基于Python实现绘制简单动图的示例详解

    动画是一种高效的可视化工具,能够提升用户的吸引力和视觉体验,有助于以富有意义的方式呈现数据可视化,本文的主要介绍在Python中两种简单制作动图的方法,需要的可以了解下
    2023-10-10
  • Python中kivy库的使用教程详解

    Python中kivy库的使用教程详解

    Kivy是一个开源Python框架,用于构建具有创意和多点触控功能的用户界面(UI)应用程序,本文主要为大家介绍了一下Kivy的具体使用,需要的可以参考下
    2024-01-01
  • python可视化plotly 图例(legend)设置

    python可视化plotly 图例(legend)设置

    这篇文章主要介绍了python可视化plotly 图例(legend)设置,主要介绍了关于python 的legend图例,参数使用说明,具有很好的参考价值,希望对大家有所帮助,需要的朋友可以参考下卖你具体内容
    2022-02-02
  • python request不走代理proxy方式

    python request不走代理proxy方式

    文章主要介绍了在Linux系统中配置代理后,使用Python的request包请求URL时会通过代理访问的情况,并提供了如何在代码中设置以避免通过代理访问的方法
    2024-11-11
  • Python迭代用法实例教程

    Python迭代用法实例教程

    这篇文章主要介绍了Python迭代用法,包括了迭代的定义及具体用法,是一个非常实用的技巧,需要的朋友可以参考下
    2014-09-09
  • Django 迁移、操作数据库的方法

    Django 迁移、操作数据库的方法

    这篇文章主要介绍了Django 迁移、操作数据库的相关知识,本文给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-08-08

最新评论