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
Fast Winnowing
To take advantage of faster fingerprinting, please install the optional scanoss_winnowing package:
pip3 install scanoss_winnowing
Or directly using:
pip3 install scanoss[fast_winnowing]
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.
Externally Managed Environments on Linux
If installing on Ubuntu 2023.04, Fedora 38, Debian 11, etc. a few additional steps are required before installing scanoss-py. More details can be found here.
The recommended method is to install pipx and use it to install scanoss-py:
sudo apt install pipx
pipx ensurepath
This will install the pipx package manager, which can then be used to install scanoss-py:
pipx install scanoss[fast_winnowing]
This will install the scanoss-py app in a separate virtual environment and create a link to the local path for execution.
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]
{version,ver,scan,sc,fingerprint,fp,wfp,dependencies,dp,dep,file_count,fc,convert,cv,cnv,cvrt,component,comp,utils,ut}
...
SCANOSS Python CLI. Ver: 1.6.1, License: MIT, Fast Winnowing: True
options:
-h, --help show this help message and exit
--version, -v Display version details
Sub Commands:
valid subcommands
{version,ver,scan,sc,fingerprint,fp,wfp,dependencies,dp,dep,file_count,fc,convert,cv,cnv,cvrt,component,comp,utils,ut}
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, but do not decorate them
file_count (fc) Search the source tree and produce a file type summary
convert (cv, cnv, cvrt)
Convert file format
component (comp) Component support commands
utils (ut) General utility support commands
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 base URL for SCANOSS OSS KB: https://api.osskb.org.
The /scan/direct endpoint is automatically appended. 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.9 or higher.
Source code
The source for this package can be found here.
Documentation
For client usage help please look here.
Changelog
Details of each release can be found here.
2 maintainers
Release files for scanoss 1.54.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.54.2.tar.gz | 259.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| scanoss-1.54.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 559.3 kB
Release files / scanoss-1.54.2.tar.gz
| Download URL | scanoss-1.54.2.tar.gz |
|---|---|
| Size | 259.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2fd6ed13b6440540553ae7bcc6997fae08b0c13711cd0ae091c348d244521cc0
|
|
BLAKE2b-256 checksum How to use checksums |
550209eb74f91ac2ce99c418a9003e65453ab339494e626aa36d59faa12d5fe7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Release files / scanoss-1.54.2-py3-none-any.whl
| Download URL | scanoss-1.54.2-py3-none-any.whl |
|---|---|
| Size | 299.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
52d84163d1af52f6540d20d6df06c147e540f789f7f5836d0cbcf161bcbf6198
|
|
BLAKE2b-256 checksum How to use checksums |
3f74b5b0e8a9aed3f64be83d410c65c81aead8b8c844b434728a1fbcf6e3f3f4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
