This script takes a dataset that meets the Orcro licence list definition, and produces generalized compliance artefacts that are suitable for use in an OpenChain compliant program.
The script requires an R interpreter to run. Any version should be fine, but the script is tested with 4.1.3
GNU Wget is used to download licence texts, ensure that it is installed. Again, any version should be fine, but the script is tested with 1.21.3
It is expected that everything should work from a POSIX compliant shell. But the script is only tested on GNU Bash.
Two .csv data files are required as input:
1- A licence list (with appropriate metadata) for a software project 2- Scancode toolkit output for the corresponding software project
Lastly, and importantly, some dependencies may be installed via a package manager (specific to the project). So you should ensure that all appropriate package managers are installed (such as npm).
The recommended way to use this script is from a shell:
Rscript generate-artefacts.R LicenceList.csv ScancodeOutput.csvGenerated artefacts will be placed into the directory that the command was run from. The licence list and scan results should be encoded in UTF-8 and be present in the working directory.
Copyright © 2022 Orcro Ltd.
This program and the accompanying materials are made available under the terms of the Apache License Version 2.0, a copy can be found in ./LICENSES/.
R is released under the GNU General Public Licence version 3 or later.
GNU Wget is released under the GNU General Public Licence version 3 or later.
🏡 Orcro Ltd. team@orcro.co.uk
🔨 Maintainer alexander.murphy@orcro.co.uk
💻 Website orcro.co.uk