fosslight-scanner 1.6.3

FOSSLight Scanner

FOSSLight Scanner

Analyze at once for Open Source Compliance.

FOSSLight Scanner performs open source analysis after downloading the source by passing a link that can be cloned by wget or git. Instead, open source analysis can be performed for the local source path. The output result is generated in FOSSLight Report format.

• FOSSLight Source Scanner Extract license and copyright in the source code using ScanCode.
• FOSSLight Dependency Scanner Extract dependency and OSS information from the package manager's manifest file.

Contents

• FOSSLight Scanner
  • Contents
  • 📋 Prerequisite
  • 🎉 How to install
  • 🚀 How to run
    • Parameters
    • Ex 1. Local Source Analysis
    • Ex 2. Download Link and analyze
  • 📁 Result
  • 👏 How to report issue
  • 📄 License

📋 Prerequisite

FOSSLight Scanner needs a Python 3.6+.

🎉 How to install

It can be installed using pip3. It is recommended to install it in the python 3.6 + virtualenv environment.

$ pip3 install fosslight_scanner

🚀 How to run

FOSSLight Scanner is run with the fosslight command.

Parameters

    -h                        Print help message
    -r                        Keep raw data 
    -s <source_path>          Path to analyze source
    -w <link>                 Link to be analyzaed can be downloaded by wget or git clone
    -o <output>               Output Directory or file
    -d <dependency_path>      Path to analyze dependencies
    -d <dependency_path> -a <additional_arg> (Using with -d option) Additional arguments for running dependency analysis  

• Ref. Additional arguments for running dependency analysis. See the FOSSLight Dependency Guide for instructions.

Ex 1. Local Source Analysis

$ fosslight -d /home/source_path -a "-a 'source /test/Projects/venv/bin/activate' -d 'deactivate'" -s /home/source_path

Ex 2. Download Link and analyze

$ fosslight -o test_result_wget -w "https://github.com/LGE-OSS/example.git"

📁 Result

$ tree
.
├── fosslight_log
│   ├── fosslight_log_20210924_022422.txt
└── FOSSLight-Report_20210924_022422.xlsx

• FOSSLight_Report-[datetime].xlsx : OSS Report format file that outputs source code analysis, binary analysis, and dependency analysis results.
• fosslight_raw_data_[datetime] directory: Directory in which raw data files are created as a result of analysis

👏 How to report issue

Please report any ideas or bugs to improve by creating an issue in fosslight_scanner repository.
Then there will be quick bug fixes and upgrades. Ideas to improve are always welcome.

📄 License

FOSSLight Scanner is released under Apache-2.0.