opossum.lib.py

This is a library to convert an SPDX document to a file readable by OpossumUI.

Current state

This is a work in progress and not yet stable.

License

Apache-2.0

Installation

This package uses uv for installation and dependency management. After installing uv, you can set up the project with

uv sync

How to use

Command-line usage

The CLI uses subcommands. The main command just displays all available subcommands

Usage: uv run opossum-file [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  generate  Generate an Opossum file from various other file formats.

generate

Usage: uv run opossum-file generate [OPTIONS]

  Generate an Opossum file from various other file formats.

  Currently supported input formats:
    - SPDX

Options:
  --spdx PATH         SPDX files used as input.
  -o, --outfile TEXT  The file path to write the generated opossum document
                      to. If appropriate, the extension ".opossum" will be
                      appended.  [default: output.opossum]
  --help              Show this message and exit.

Development

To test your changes, run

uv run ruff check
uv run ruff format --check
uv run python -m mypy src/ tests/
uv run pytest