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
ReportLab
Metadata
Release files for ossreport 2.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ossreport-2.0.0.tar.gz | 14.3 kB | Without provenance | Details for ossreport-2.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ossreport-2.0.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for ossreport-2.0.0-py2.py3-none-any.whl |
Total release size: 55.7 kB
Release files / ossreport-2.0.0.tar.gz
| Download URL | ossreport-2.0.0.tar.gz |
|---|---|
| Size | 14.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
08419ccd197de88b090ccd4ae786ac49b5c69013242780f6bea7ec5c5ce53dd6
|
|
BLAKE2b-256 checksum How to use checksums |
d849972110e1fa2a810f4ec097471099a40f6174ddc8cbc994acec802802258e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.6.9
|
Release files / ossreport-2.0.0-py2.py3-none-any.whl
| Download URL | ossreport-2.0.0-py2.py3-none-any.whl |
|---|---|
| Size | 41.4 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
24e3884979390adbf5d42a88dbbe84be6175b6a9dd88d9b4006311871e9cd6b7
|
|
BLAKE2b-256 checksum How to use checksums |
b14b3b0bb43bd0c408a6ca898ff54817d387546423b32a3a4a2fd7052422a40a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.6.9
|
Security for ossreport 2.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.