Skip to main content
SCANOSS-PY provides a simple, easy-to-consume library for interacting with SCANOSS APIs and engines.

​
Prerequisites

Before you begin, make sure you have:

​
Installation

​
Standard Installation

Install SCANOSS-PY from PyPI: 
# Install from PyPI
pip3 install scanoss

# Upgrade existing installation
pip3 install --upgrade scanoss

​
Fast Winnowing

Provides 15x performance improvement in fingerprinting. 
# Install with fast winnowing support
pip3 install scanoss[fast_winnowing]

# Or install separately
pip3 install scanoss_winnowing
To check if fast winnowing is enabled: 
scanoss-py utils fast

​
Dependency Scanning

To enable dependency scanning from package manifests and lockfiles (package.json, requirements.txt, pom.xml, etc.), install scancode-toolkit: 
pip install scancode-toolkit
This is only required if you want to use the -D or --dependencies flag for scanning declared dependencies. Standard file and snippet scanning does not require this dependency.

​
Installation on Externally Managed Environments

Modern Linux distributions (Ubuntu 23.04+, Fedora 38+, Debian 11+) use externally managed Python environments. Use pipx for isolated installations: 
# Install scanoss-py
pipx install scanoss

# Upgrade existing installation
pipx upgrade scanoss

# Install scanoss-py with fast winnowing support
pipx install scanoss[fast_winnowing]

# Instal scancode-toolkit to scan for scanning declared dependencies
pipx install scancode-toolkit