> ## 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.

# Overview

> The SCANOSS Python SDK is a library for integrating with the SCANOSS API and scanning engine from Python scripts and applications.

## Prerequisites

Before you begin, ensure you have the following installed:

* [Python 3.9 or higher](https://www.python.org/)

## Installation

Install the package from [PyPI](https://pypi.org/project/scanoss):

```bash theme={null}
pip install scanoss
```

## Quick Start

To initiate a scan using all the SCANOSS defaults:

```python theme={null}
from scanoss.scanner import Scanner
from scanoss.scanoss_settings import ScanossSettings

def main():
    scanner = Scanner(scanoss_settings=ScanossSettings())
    scanner.scan_folder_with_options('/path/to/project')

if __name__ == "__main__":
    main()
```