cyclonedx/cyclonedx-python

CycloneDX Python Module Docker镜像文档

镜像概述

CycloneDX Python Module Docker镜像用于为Python项目生成符合CycloneDX规范的软件物料清单(SBOM)，其中包含项目所有依赖项的汇总信息。CycloneDX是一种轻量级BOM规范，具有易于创建、机器可读和解析简单的特点，适用于依赖管理、合规性检查和供应链安全分析等场景。

核心功能与特性

• 生成包含Python项目所有依赖项的标准CycloneDX SBOM
• 支持自定义依赖文件路径和输出文件路径
• 遵循Apache 2.0开源许可协议

使用场景

• Python项目依赖管理与审计
• 软件供应链安全合规检查
• 项目依赖项文档生成与版本追踪

使用方法

冻结依赖

CycloneDX SBOM要求精确的版本号，因此需先冻结项目依赖至requirements.txt文件。执行以下命令完成依赖冻结：

bash
$ pip freeze > requirements.txt

执行命令

通过Docker运行镜像生成SBOM：

bash
$ docker run cyclonedx/cyclonedx-python [OPTIONS]

配置选项

默认情况下，镜像会读取当前工作目录下的requirements.txt并在当前目录生成bom.xml。可通过以下选项自定义路径：

• -i <path>：指定替代的冻结依赖文件路径（默认为requirements.txt）
• -o <path>：指定SBOM输出文件路径（默认为bom.xml）

许可证

本镜像基于Apache 2.0许可协议发布，允许修改和再分发。