Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scanoss.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

Before you begin, ensure you have the following installed:

​
Installation

Install the package from PyPI: 
pip3 install scanoss

​
Default API Endpoint

By default, the Scanner class (the primary interface for initiating scans) sends requests to the SCANOSS OSS Knowledge Base API at: 
https://api.osskb.org
To use a different endpoint, pass the desired URL when initialising Scanner. See Configuration for details.