Generating an SBOM for Python (pip / Poetry)

The step below writes a CycloneDX JSON file in your own pipeline. The CRA Desk scan reads that file and turns it into a readiness report - it never generates one for you.

Run in CI:

pip install -r requirements.txt
pip install cyclonedx-bom
cyclonedx-py environment -o sbom.json

Produces:

sbom.json

Format:

CycloneDX JSON

The whole CI job

- uses: actions/checkout@v4
- run: pip install -r requirements.txt
- run: pip install cyclonedx-bom
- run: cyclonedx-py environment -o sbom.json
- uses: mmalinowski/cradesk-action@v1
  with:
    sbom-path: sbom.json

generate-sbom:
  script:
    - pip install -r requirements.txt
    - pip install cyclonedx-bom
    - cyclonedx-py environment -o sbom.json

include:
  - component: gitlab.com/cradesk/scan/readiness@1
    inputs:
      sbom_path: sbom.json

Only the first step changes with your stack - the CRA Desk step after it is identical everywhere.

What goes wrong here

cyclonedx-py environment describes the installed environment, not requirements.txt, so dependencies have to be installed first. For a lockfile instead, use cyclonedx-py poetry or cyclonedx-py requirements.

What CRA Desk does with the result

Components from this build carry pkg:pypi package URLs, which the watch matches against OSV's PyPI advisories when the SBOM arrives and again as new advisories land. Matching runs on every plan; e-mail alerts and the full match list are what a paid plan adds.

A generator that runs is not the same as coverage. Components with no purl, no version, or from an ecosystem outside the nine we watch are counted as gaps in every report rather than reported as clean.