README.md

opOSSum-lib

This is a helper library for generating inputs for the OpossumUI

• State: work in progress / hacky

usage of CLI

This project contains the helper script ./opossum-lib-exe.sh, that can be executed out of the box, and it builds on demand.

$ ./opossum-lib-exe.sh --help
 ARG [ARG [ARG ...]]]
    where ARG one of
                FILE           <-- parse opossum file
                DIR            <-- generate opossum from file tree
     --spdx     SPDX_JSON      <-- parse .spdx.json
     --spdx     SPDX_YAML      <-- parse .spdx.yaml
     --scancode SCANCODE_JSON  <-- parse scancode json
     --dependency-check DC_JSON <-- parse OWASP Dependency-Check JSON
     --scanoss SCANOSS_JSON  <-- parse scanoss json
or
 --merge-relative OPOSSUM [OPOSSUM [OPOSSUM [...]]]

You can run the following command, to generate an input file from several input files, a scancode file and a spdx file.

$ ./opossum-lib-exe.sh \
        path/to/input1.json \
        path/to/input2.json.gz \
        --scancode path/to/scancode.json \
        --spdx path/to/some.spdx.json \
        > target/path/to/file.json

Dev

To build

$ stack build

To test

$ stack test --file-watch