首页
/ 推荐项目:build-and-inspect-python-package - 您的Python包质量守护者!

推荐项目:build-and-inspect-python-package - 您的Python包质量守护者!

2024-06-12 12:59:23作者:贡沫苏Truman

当发布Python包到PyPI时,确保一切正确无误是至关重要的。这就是build-and-inspect-python-package发挥作用的地方——一个高效且可靠的GitHub Action工具,它专为Python包维护者设计,帮助您在上传之前构建并检验您的软件包。

1. 项目介绍

build-and-inspect-python-package是一个GitHub Action,提供以下功能:

  • 使用PEP 517兼容的build构建您的Python包。
  • 自动将构建好的轮子(wheel)和源分布文件(source distribution)作为GitHub Actions Artifacts。
  • 验证和检查构建后的轮子内容,以及PyPI上的README。
  • 提供清晰的文件树视图,让您无需下载就能查看包内容。
  • 输出打包元数据以供进一步检查。

这个工具旨在帮助您创建可重复构建的、质量上乘的Python包,并提升您的PyPI用户体验。

2. 技术分析

该项目基于一系列先进的Python包管理工具,如buildcheck-wheel-contentstwine。通过设置SOURCE_DATE_EPOCH,它保证了每次构建都是可复制的,同时保持文件时间戳有意义。此外,它还利用了GitHub Actions的Artifacts功能,便于您进行事后验证。

3. 应用场景

  • 跨任务共享构建:在一个步骤中构建您的包,并在后续步骤中依赖这个构建结果进行测试,模拟真实用户环境。
  • 自动上传到PyPI:结合GitHub事件,您可以自动化地将验证过的包上传到Test PyPI或生产PyPI。
  • 矩阵式Python版本测试:基于包元数据定义Python版本测试矩阵,避免信息冗余。

4. 项目特点

  • 全方位检查:从构建、轮子内容到PyPI README,每个细节都经过仔细检查。
  • 可复用性:一次构建,多处使用,提高测试一致性。
  • 高度自定义:支持跳过轮子构建、调整artifact名称等个性化设置。
  • 信息集成:自动生成Python版本支持列表,简化CI配置。

实际应用示例

项目如structlog已经在其CI流程中成功采用了build-and-inspect-python-package,实现了对包的高质量管理和验证。

结论

为了确保您的Python包品质一流并避免错误地上传,使用build-and-inspect-python-package是不可或缺的。立即在您的GitHub仓库中加入此行动,体验更智能、更安全的包发布流程吧!

想要开始使用?只需在.github/workflows目录下添加简单的YAML配置即可启动这个神奇的工具。查看项目文档以获取详细说明和更多示例。

jobs:
  check-package:
    name: Build & inspect our package.
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - uses: hynek/build-and-inspect-python-package@v2

您的代码质量,我们来守护!

热门项目推荐
相关项目推荐

项目优选

收起
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
263
53
国产编程语言蓝皮书国产编程语言蓝皮书
《国产编程语言蓝皮书》-编委会工作区
64
16
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
85
63
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
53
44
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
195
45
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
268
69
xxl-jobxxl-job
XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
Java
9
0
RuoYi-VueRuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
171
41
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
38
24
qwerty-learnerqwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
332
27