ossreport

Introduction

ossreport is a report tool for SCANOSS written in Python.

Prerequisites

• Python >= 3.7.0

Run

git clone https://github.com/craftslab/ossreport.git

cd ossreport
pip install -Ur requirements.txt
python report.py --config-file="config.yml" --license-file "license.json" --scanoss-file "scanoss.json" --output-file "output.pdf"

Docker

git clone https://github.com/craftslab/ossreport.git

cd ossreport
docker build --no-cache -f Dockerfile -t craftslab/ossreport:latest .
docker run -it -v /tmp:/tmp craftslab/ossreport:latest ./ossreport --config-file="config.yml" --license-file "license.json" --scanoss-file "/tmp/scanoss.json" --output-file "/tmp/output.pdf"

Usage

usage: report.py [-h] [--config-file CONFIG_FILE]
                 [--license-file LICENSE_FILE] --output-file OUTPUT_FILE
                 --scanoss-file SCANOSS_FILE [-v]

SCANOSS Report

optional arguments:
  -h, --help            show this help message and exit
  --config-file CONFIG_FILE
                        config file (default: ossreport/config/config.yml)
  --license-file LICENSE_FILE
                        license file (default: ossreport/data/license.json)
  --output-file OUTPUT_FILE
                        output file (.pdf|.xlsx)
  --scanoss-file SCANOSS_FILE
                        scanoss file (.json)
  -v, --version         show program's version number and exit

Settings

ossreport parameters can be set in the directory config.

An example of configuration in config.yml:

apiVersion: v1
kind: worker
metadata:
  name: ossreport
spec:
  risk:
    license:
      critical:
      high:
        permissions:
          - commercial-use
          - modifications
          - distribution
          - patent-use
          - private-use
        conditions:
          - include-copyright
          - document-changes
          - disclose-source
          - same-license
        limitations:
          - liability
          - warranty
      medium:
        permissions:
        conditions:
        limitations:
      low:
        permissions:
          - commercial-use
          - modifications
          - distribution
          - patent-use
          - private-use
        conditions:
          - include-copyright
          - document-changes
        limitations:
          - trademark-use
          - liability
          - warranty
      none:
        permissions:
        conditions:
        limitations:

License

Project License can be found here.

Reference

License

• choosealicense-rules
• choosealicense-table
• github-licenses
• spdx-license

ReportLab

• reportlab-example
• reportlab-userguide