Skip to main content

No project description provided

Project description


CI Status PyPI - Python Version PyPI - Version

protobom-py is a Python wrapper for bom-squad/protobom that can be used to generate both SPDX and CycloneDX SBOMs from Python code. There are two main parts:

  1. protobom_py.sbom_pb2 provides precompiled Protobuf definitions for the Protobom format.
  2. protobom_py.convert() can be used to render SPDX and CycloneDX SBOMS from the Protobom format.


import protobom_py

document = protobom_py.sbom_pb2.Document()
spdx = protobom_py.convert(document, "spdx")

proto = b"..."
cyclonedx = protobom_py.convert(proto, "cyclonedx")

See tests/ for more in-depth examples.



The project maintains a strict 100% test coverage. You can run tests locally as follows:

pdm run test

Code Style

The project enforces a consistent code style using Ruff:

pdm run fmt


protobom is written in Go, which makes it tricky to distribute Python bindings. While projects such as gopy make it possible to generate CPython extensions, this approach would require {Windows, Linux, macOS} x {Python 3.10, Python 3.11, Python 3.12, ...} individual wheel distributions, which is not very sustainable. To simplify distribution, protobom_py uses an alternative approach:

  1. ./protobom-writer contains a small Go binary that converts a Protobom file to either SPDX or CycloneDX.
  2. This binary is compiled to Go's WebAssembly/WASI target.
  3. protobom_py uses wasmtime to execute the wasm binary when convert() is called.

The WASM binary works across platforms, so only a single binary distribution is needed.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

protobom_py-0.1b1.tar.gz (18.0 kB view hashes)

Uploaded Source

Built Distribution

protobom_py-0.1b1-py3-none-any.whl (2.7 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page