FOSSLight Scanner
Project description
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
📋 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 <dir_name> Output Directory
-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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fosslight_scanner-1.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d4f754b079857f2c56e26a83cfdd41dca0529abbd9e1ab74b871678eacb697ab |
|
MD5 | 39c827d30f2bf83b939f594c800e4d4c |
|
BLAKE2b-256 | 8ea95f481ee32942e317c1d6270e82570cd4523bf70d0b55b7ebfffa8f5177d5 |