如何利用GitHubAction来发布自己的Python软件包

2024-05-26 06:04

本文主要是介绍如何利用GitHubAction来发布自己的Python软件包,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

我们开发的python软件包如果想发布到网上,可以让其他人通过pip install下载,一般是把软件包发布到PYPI平台。

PYPI准备

我们要现在pypi注册登录一下

文件组织架构

一般的python软件包的文件组织架构为包名文件夹+__init__.py+程序,包文件夹的同级有setup.py

.
│  LICENSE
│  README.md
│  setup.py
│
├─.github
│  └─workflows
│          publish-to-pypi.yml
│
└─package_nameproject.py__init__.py

这里我们要额外加一个.gituhb/workflows的文件夹,存储Action配置文件

配置Action

atcion文件示例如下


name: Publish Python 🐍 distributions 📦 to PyPIon:release:types: [published]  # This will trigger the workflow only when a new release is publishedjobs:build-n-publish:name: Build and publish Python 🐍 distributions 📦 to PyPIruns-on: ubuntu-22.04steps:- uses: actions/checkout@v2- name: Set up Pythonuses: actions/setup-python@v2with:python-version: '3.10'- name: Install pypa/buildrun: python -m pip install build- name: Build a binary wheel and a source tarballrun: python -m build --sdist --wheel . --outdir dist/- name: Install twinerun: python -m pip install twine- name: Publish distribution to PyPIenv:TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}run: twine upload dist/*

这里定义了在虚拟环境中的操作,打包然后利用twine发布包到pypi。

注意这里需要在仓库中配置secret:Settiing -> Secrets and vairables -> Action -> Repository secrets -> New 然后点击新建两个变量,分别取名PYPI_USERNAME和PYPI_PASSWORD,其中的value分别对应我们的pypi用户名和密码。

如果账户配置了双重认证,就得去pypi申请一个API:在pypi官网点击自己的用户名,选择Account settings,拉到最下面申请API

不能用用户名和密码登录了相应的代码也要一些修改

      env:TWINE_USERNAME: __token__TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}

pypi中还需要配置一个信任的来源,填写你的仓库和包的信息

Action我们设置的是在仓库发布relase之后触发,所以我们需要先提交一个release

发布release之后action就会自动触发然后推送我们的包到pypi了

这篇关于如何利用GitHubAction来发布自己的Python软件包的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1003671

相关文章

python常见环境管理工具超全解析

《python常见环境管理工具超全解析》在Python开发中,管理多个项目及其依赖项通常是一个挑战,下面:本文主要介绍python常见环境管理工具的相关资料,文中通过代码介绍的非常详细,需要的朋友... 目录1. conda2. pip3. uvuv 工具自动创建和管理环境的特点4. setup.py5.

Python常用命令提示符使用方法详解

《Python常用命令提示符使用方法详解》在学习python的过程中,我们需要用到命令提示符(CMD)进行环境的配置,:本文主要介绍Python常用命令提示符使用方法的相关资料,文中通过代码介绍的... 目录一、python环境基础命令【Windows】1、检查Python是否安装2、 查看Python的安

Python UV安装、升级、卸载详细步骤记录

《PythonUV安装、升级、卸载详细步骤记录》:本文主要介绍PythonUV安装、升级、卸载的详细步骤,uv是Astral推出的下一代Python包与项目管理器,主打单一可执行文件、极致性能... 目录安装检查升级设置自动补全卸载UV 命令总结 官方文档详见:https://docs.astral.sh/

Python并行处理实战之如何使用ProcessPoolExecutor加速计算

《Python并行处理实战之如何使用ProcessPoolExecutor加速计算》Python提供了多种并行处理的方式,其中concurrent.futures模块的ProcessPoolExecu... 目录简介完整代码示例代码解释1. 导入必要的模块2. 定义处理函数3. 主函数4. 生成数字列表5.

Python中help()和dir()函数的使用

《Python中help()和dir()函数的使用》我们经常需要查看某个对象(如模块、类、函数等)的属性和方法,Python提供了两个内置函数help()和dir(),它们可以帮助我们快速了解代... 目录1. 引言2. help() 函数2.1 作用2.2 使用方法2.3 示例(1) 查看内置函数的帮助(

Python虚拟环境与Conda使用指南分享

《Python虚拟环境与Conda使用指南分享》:本文主要介绍Python虚拟环境与Conda使用指南,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、python 虚拟环境概述1.1 什么是虚拟环境1.2 为什么需要虚拟环境二、Python 内置的虚拟环境工具

Python实例题之pygame开发打飞机游戏实例代码

《Python实例题之pygame开发打飞机游戏实例代码》对于python的学习者,能够写出一个飞机大战的程序代码,是不是感觉到非常的开心,:本文主要介绍Python实例题之pygame开发打飞机... 目录题目pygame-aircraft-game使用 Pygame 开发的打飞机游戏脚本代码解释初始化部

Python pip下载包及所有依赖到指定文件夹的步骤说明

《Pythonpip下载包及所有依赖到指定文件夹的步骤说明》为了方便开发和部署,我们常常需要将Python项目所依赖的第三方包导出到本地文件夹中,:本文主要介绍Pythonpip下载包及所有依... 目录步骤说明命令格式示例参数说明离线安装方法注意事项总结要使用pip下载包及其所有依赖到指定文件夹,请按照以

Python实现精准提取 PDF中的文本,表格与图片

《Python实现精准提取PDF中的文本,表格与图片》在实际的系统开发中,处理PDF文件不仅限于读取整页文本,还有提取文档中的表格数据,图片或特定区域的内容,下面我们来看看如何使用Python实... 目录安装 python 库提取 PDF 文本内容:获取整页文本与指定区域内容获取页面上的所有文本内容获取

基于Python实现一个Windows Tree命令工具

《基于Python实现一个WindowsTree命令工具》今天想要在Windows平台的CMD命令终端窗口中使用像Linux下的tree命令,打印一下目录结构层级树,然而还真有tree命令,但是发现... 目录引言实现代码使用说明可用选项示例用法功能特点添加到环境变量方法一:创建批处理文件并添加到PATH1