Skip to main content

​
Prerequisites

Before you begin, ensure you have the following installed:

​
Installation

Install the package from PyPI: 
pip install scanoss

​
Quick Start

To initiate a scan using all the SCANOSS defaults: 
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()