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 poetry for installation and dependency management. To install the local clone of this repo run

poetry install  # in the root of the repo

How to use

Command-line usage

Usage: spdx2opossum [OPTIONS]

  CLI-tool for converting SPDX documents to Opossum documents.

Options:
  -i, --infile PATH   The file containing the document to be converted.
                      [required]
  -o, --outfile TEXT  The file path to write the generated opossum document
                      to. The generated file will be an opossum file, if the
                      specified file path doesn't match this file extension
                      ".opossum" will be appended.
  --help              Show this message and exit.

Development

To test your changes run

poetry run pytest  # in the root of the repo

The package uses pre-commit hooks to check the code style of your changes. It also provides a script (./scripts/linter_and_formatting.sh) to make your changes compliant with the expected code style. To use this script under linux run

./scripts/linter_and_formatting.sh  # in the root of the repo