pipelinecomponents/python-safety

Pipeline Components: Python Safety (pyup.io) 镜像文档

镜像概述

本镜像基于 python:3.7-alpine3.8 构建，集成了 pyup.io 的 Safety 工具，用于检查 Python 项目依赖项中的安全漏洞。主要用于集成到 CI/CD 流水线（特别是 GitLab CI），提供自动化的依赖安全审计能力。

核心功能与特性

• 轻量级基础：基于 Alpine Linux 的 Python 3.7 镜像，体积小、启动速度快
• 安全检查：集成 pyup.io Safety 工具，可扫描 Python 依赖中的已知安全漏洞
• 灵活配置：支持通过环境变量 SAFETY_API_KEY 配置 pyup.io 付费服务的 API 密钥
• CI/CD 友好：专为自动化流程设计，无缝集成到 GitLab CI 等持续集成环境

使用场景

• GitLab CI 流水线中的代码检查阶段（如 linting 阶段）
• Python 项目依赖项的自动化安全漏洞扫描
• 持续集成流程中的依赖安全合规验证
• 开发环境中的本地依赖安全审计

使用方法与配置说明

环境变量

GitLab CI 配置示例

在 .gitlab-ci.yml 中添加安全检查阶段：

yaml
python-safety:
  stage: linting
  image: registry.gitlab.com/pipeline-components/python-safety:latest
  script:
    - safety check --full-report -r requirements.txt

本地 Docker 运行示例

检查本地项目的依赖安全漏洞：

bash
# 挂载当前目录并检查 requirements.txt
docker run -v $(pwd):/app -w /app registry.gitlab.com/pipeline-components/python-safety:latest safety check --full-report -r requirements.txt

版本控制

本项目采用 语义化版本控制（Semantic Versioning）管理版本号。

支持与反馈

如有问题：

• 可加入 *** 频道 交流
• 或在 项目 Issues 页面 提交问题

贡献指南

这是一个活跃的开源项目，欢迎使用或贡献代码。贡献指南详见 CONTRIBUTING.md。感谢您的参与！

作者与贡献者

本仓库的初始设置由 Robbert Müller 完成。构建流水线主要基于 https://github.com/hassio-addons（由 https://github.com/frenck 创建）。完整的作者和贡献者列表，请查看 贡献者页面。

许可证

MIT 许可证

版权所有 (c) 2018 Robbert Müller

特此授予获得本软件及相关文档文件（以下简称“软件”）副本的任何人免费许可，不受限制地处理本软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件的副本，并允许向其提供软件的人这样做，但须符合以下条件：

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

本软件按“原样”提供，不提供任何明示或暗示的担保，包括但不限于对适销性、特定用途适用性和非侵权性的担保。在任何情况下，作者或版权持有人均不对因软件或软件的使用或其他交易而引起的任何索赔、损害或其他责任承担责任，无论是合同诉讼、侵权诉讼还是其他形式的诉讼。