Skip to content

Latest commit

 

History

History
50 lines (42 loc) · 1.92 KB

GHCR.md

File metadata and controls

50 lines (42 loc) · 1.92 KB
Raw

SCANOSS GitHub Container Repository - GHCR

The SCANOSS python package provides a simple easy to consume library for interacting with SCANOSS APIs/Engine.

This GitHub Container Package repo provides this package in an easy to install/run image.

Installation

To install (from GHCR), please run:

docker pull ghcr.io/scanoss/scanoss-py:latest

Usage

The Python CLI is exposed from the image and can be run using:

docker run -it ghcr.io/scanoss/scanoss-py

To scan the current folder run:

docker run -it -v "$(pwd)":"/scanoss" ghcr.io/scanoss/scanoss-py scan .

To output the results to a file run:

docker run -it -v "$(pwd)":"/scanoss" ghcr.io/scanoss/scanoss-py scan -o results.json .

To redirect output to a file run:

docker run -i -v "$(pwd)":"/scanoss" ghcr.io/scanoss/scanoss-py scan . > output.json

To scan for dependencies and output the results to a file run:

docker run -it -v "$(pwd)":"/scanoss" ghcr.io/scanoss/scanoss-py scan -D -o results.json .

Scancode

To support dependency scanning, this container contains the Python scancode-toolkit. While scanning the source paths, the SCANOSS CLI can (if requested) use scancode to search for dependency files. SCANOSS then takes this output and decorates it with license information, etc.

To run scancode standalone from this image please run:

docker run -it -v "$(pwd)":"/scanoss" --entrypoint scancode ghcr.io/scanoss/scanoss-py --help

Source code

The source for this repo can be found here.

Changelog

Details of each release can be found here.

GHCR image tags

Image tag/version details can be found here.