SCANOSS Python Package
The SCANOSS python package provides a simple easy to consume library for interacting with SCANOSS APIs/Engine.
Installation
To install (from pypi.org), please run:
pip3 install scanoss
To upgrade an existing installation please run:
pip3 install --upgrade scanoss
Docker
Alternatively, there is a docker image of the compiled package. It can be found here. Details of how to run it can be found here.
Usage
The package can be run from the command line, or consumed from another Python script.
CLI Usage
The Python package manager (pip), will register the following command during installation:
scanoss-py
It is also possible to launch it using:
python3 -m scanoss.cli
Running the bare command will list the available sub-commands:
> scanoss-py
usage: scanoss-py [-h] {version,ver,scan,sc,fingerprint,fp,wfp,dependencies,dp,dep} ...
SCANOSS Python CLI. Ver: 0.9.0, License: MIT
optional arguments:
-h, --help show this help message and exit
Sub Commands:
valid subcommands
{version,ver,scan,sc,fingerprint,fp,wfp,dependencies,dp,dep}
sub-command help
version (ver) SCANOSS version
scan (sc) Scan source code
fingerprint (fp, wfp)
Fingerprint source code
dependencies (dp, dep)
Scan source code for dependencies
From there it is possible to scan a source code folder:
> scanoss-py scan -o scan-output.json <source-folder>
Scanning for Dependencies
The SCANOSS CLI supports dependency decoration. In order for this to work, it requires the installation of scancode:
pip install scancode-toolkit
Dependencies can then be decorated by adding the --dependencies option to the scanner:
> scanoss-py scan --dependencies -o scan-output.json <source-folder>
Package Usage
The scanoss package can also be used in other Python projects/scripts. A good example of how to consume it can be found here.
In general the easiest way to consume it is to import the required module as follows:
from scanoss.scanner import Scanner
def main():
scanner = Scanner()
scanner.scan_folder( '.' )
if __name__ == "__main__":
main()
Scanning URL and API Key
By Default, scanoss uses the API URL endpoint for SCANOSS OSS KB: https://osskb.org/api/scan/direct. This API does not require an API key.
These values can be changed from the command line using:
> scanoss-py scan --apiurl <URL> --key <KEY>
From code, it would look like this:
from scanoss.scanner import Scanner
def main():
scanner = Scanner(url='new-url', api_key='key')
scanner.scan_folder( '.' )
if __name__ == "__main__":
main()
Requirements
Python 3.7 or higher.
Source code
The source for this package can be found here.
Changelog
Details of each release can be found here.
2 maintainers
Metadata
2 maintainers
Release files for scanoss 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| scanoss-1.0.2.tar.gz | 43.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| scanoss-1.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 135.2 kB
Release files / scanoss-1.0.2.tar.gz
| Download URL | scanoss-1.0.2.tar.gz |
|---|---|
| Size | 43.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f2b65869c65f2c87bec5533779d8484dc9d57675514f24dd23c74655c0e62c53
|
|
BLAKE2b-256 checksum How to use checksums |
8e3a77609e0f0cb2917eab00ad0fe6bcc8dae8136c857641b30e7d64f9ba741a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.10
|
Release files / scanoss-1.0.2-py3-none-any.whl
| Download URL | scanoss-1.0.2-py3-none-any.whl |
|---|---|
| Size | 92.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5d0a934c898cd50ef5ab474824016eb867b7d0eac19712fbbd5f2014b16ff733
|
|
BLAKE2b-256 checksum How to use checksums |
334a2c06021444d0615b1ae17463e94552f2b1b0b178db5c5019d34ac9c29fd8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.10
|
