首页
/ 推荐项目: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

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

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

项目优选

收起
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
34
25
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
835
0
redis-sdkredis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
376
34
advanced-javaadvanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.92 K
19.09 K
qwerty-learnerqwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.63 K
1.45 K
Yi-CoderYi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
58
7
RuoYi-VueRuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
147
26
杨帆测试平台杨帆测试平台
扬帆测试平台是一款高效、可靠的自动化测试平台,旨在帮助团队提升测试效率、降低测试成本。该平台包括用例管理、定时任务、执行记录等功能模块,支持多种类型的测试用例,目前支持API(http和grpc协议)、性能、CI调用等功能,并且可定制化,灵活满足不同场景的需求。 其中,支持批量执行、并发执行等高级功能。通过用例设置,可以设置用例的基本信息、运行配置、环境变量等,灵活控制用例的执行。
JavaScript
9
1
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
19
2
go-iot-platformgo-iot-platform
Go IoT 平台,这是一个高效、可扩展的物联网解决方案,使用 Go 语言开发。本平台专注于提供稳定、可靠的 MQTT 客户端管理,以及对 MQTT上报数据的全面处理和分析。
Go
9
4