README.md

ldbcollector

This is a framework to collect, parse, normalize and join metadata about open source and other software licenses.

Quickstart:

Get the docker image

If permissions allow, one can fetch the image from ghcr.io

$ docker pull ghcr.io/maxhbr/ldbcollector-with-data:latest

or download the ldbcollector-with-data.tar.gz artifact created by github actions and load it with docker load ...

Run the docker image

$ docker run --env PORT=3001 -p "3001:3001" "ghcr.io/maxhbr/ldbcollector-with-data:latest"

One might need to adopt the tag, to match the image in the local registry.

History:

This is a rewrite of the old ldbcollector, which is found in the branch v1.

This rewrite is not yet stable and for stable use the old version is prefered.

Licensing

The code writen for this project is licensed under BSD-3-Clause. The data in ./data is licensed under the respective licenses.

Sources and Outputs

graph LR;
    BlueOak["Blue Oak Council\nPermissive license list\nCopyleft license list"]--->LDBcollector["ldbcollector"];
    Cavil["Cavil\ngithub.com/openSUSE/cavil"]---->LDBcollector;
    ChooseALicense["choosalicense.com"]--->LDBcollector;
    EclipseOrgLegal["eclipse.org/legal/license.json"]---->LDBcollector;
    Fedora["gitlab.com/fedora/legal/fedora-license-data"]--->LDBcollector;
    FOSSLight---->LDBcollector;
    Fossology--->LDBcollector;
    FSF["gnu.org/licenses/license-list.html"]---->LDBcollector;
    GoogleLicensePolicy["opensource.google/documentation/reference/thirdparty/licenses"]--->LDBcollector;
    HitachiOpenLicense["github.com/Hitachi/open-license"]---->LDBcollector;
    Ifross["ifross.github.io/ifrOSS/Lizenzcenter"]--->LDBcollector;
    Metaeffekt["metaeffekt.com/#universe"]---->LDBcollector;
    OKFN["opendefinition.org/licenses"]--->LDBcollector;
    OSADL["OSADL Open Source License Checklists"]---->LDBcollector;
    OSI["opensource.org/licenses"]--->LDBcollector;
    OSLC["github.com/finos/OSLC-handbook"]---->LDBcollector;
    Scancode["scancode-licensedb.aboutcode.org"]--->LDBcollector;
    SPDX["spdx.org/licenses"]---->LDBcollector;
    Warpr["github.com/warpr/licensedb"]--->LDBcollector;
    Hermine["gitlab.com/hermine-project/hermine-data"]---->LDBcollector;
    FossLicenses["github.com/hesa/foss-licenses"]--->LDBcollector;

    Curation["Manual Curations"]-->LDBcollector;

    LDBcollector-->GraphViz;
    LDBcollector-->JSON;
    LDBcollector-->Metrics;
    LDBcollector--->Server["Interactive Server\nto browse and analyze\nserved on localhost:3000"];
    GraphViz --> Server;
    JSON --> Server;
    LDBcollector--> Wiki;
    LDBcollector--->Policy["Open Source Policy"];
    Wiki-->Policy;

Loading

Ways to build, run and develop:

After cloning, one needs to initialize the submodules, e.g. with git submodule update --init --recursive || true (some recursive submodules might fail, this is not a problem and should be ignored).

Nix

Nix is used to build the package and to create a container with it. It uses flakes.

Develop

A development environment where cabal is provided can be started with nix develop. One can directly trigger cabal comands via nix develop --command "cabal build --test". This is wrapped in ./nix-develop*.sh scripts.

The fmt.sh script is used to apply formatting rules to the code.

Building

The relevant targets are:

• nix build .# or nix build .#ldbcollector to build the package
• nix build .#ldbcollector-untested to build the package without tests in nix
• nix build -o ldbcollector.tar.gz .#ldbcollector-image to build the container
  • it will create an output in ldbcollector.tar.gz and has the tag maxhbr/ldbcollector:latest and can be loaded with docker load -i ldbcollector.tar.gz
  • this is wrapped in the script ./nix-docker-build-and-load.sh

Docker with data

The script ./.github/workflows/docker-add-data-to-img.sh is used to add the data to the container. It is used in the pipeline and creates {ghcr.io/}maxhbr/ldbcollector-with-data:latest.

Building and Running

• nix run .# or nix run .#ldbcollector to (build and) run the package
  • this is wrapped in the script ./nix-run.sh
• for development one can also use nix develop --command cabal run to (build and) run it directly via cabal in the dev environment

Docker

If the relevant docker images is available (maxhbr/ldbcollector or localhost/maxhbr/ldbcollector), you can run the container with

./docker-run.sh

There is no direct way to build the image without nix, but you can fetch the images from ghcr.io (docker pull ghcr.io/maxhbr/ldbcollector:latest or docker pull ghcr.io/maxhbr/ldbcollector-with-data:latest, if you have permissions or if they become public) or as a build artifact of the pipeline.

Cabal

This is also a cabal project and can be developed that way. But the nix way is prefered and actually used.