FOSSLight Scanner performs open source analysis after downloading the source by passing a link that can be cloned by wget or git.

Last update: Nov 03, 2022

Overview

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.

FOSSLight Scanner

📋 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 
    -p 
   
                     Path to analyze source
    -w 
                     Link to be analyzaed can be downloaded by wget or git clone
    -o 
                   Output Directory or file
    -f 
     
                     Output file format (excel, csv, opossum)
    -c 
      
                       Number of processes to analyze source
    -d 
       
         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 -p /home/source_path -a "-a 'source /test/Projects/venv/bin/activate' -d 'deactivate'"

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.

Comments

does not work fosslight_scanner in Windows 10
Describe the bug does not work fosslight_scanner in Windows 10 Home 21H2

To Reproduce fosslight_scanner What are you going to analyze? (1/2) 1. Links that can be cloned by git or wget 2. Local source path 1 Enter the link to analyze:https://github.com/LGE-OSS/example

Expected behavior

Enter the link to analyze:https://github.com/LGE-OSS/example Link to download: https://github.com/LGE-OSS/example

FOSSLight Downloader - Result :False module 'signal' has no attribute 'SIGALRM' Download failed: module 'signal' has no attribute 'SIGALRM'

System environment (please complete the following information):

OS: Windows 10 Home 21H2

Python : python 3.9.12 (with Anaconda 3)

bug
opened by kjhcav 3
Support yaml format of FOSSLight Report
Signed-off-by: Jiyeong Seok [email protected]

Description

Support yaml format of FOSSLight Report

Type of change

Please insert 'x' one of the type of change.

[ ] Bug fix (non-breaking change which fixes an issue)

[x] New feature (non-breaking change which adds functionality)

[ ] Documentation update

[ ] Refactoring, Maintenance

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

enhancement
opened by dd-jy 2
Fix bug about dep. arg input when not dep. running
Description

Fix bug about dep. arg input when not dep. running

Add importlib-metadata to requirement-dev.txt with specific version as a dependency for test on Python-3.7

Type of change

Please insert 'x' one of the type of change.

[x] Bug fix (non-breaking change which fixes an issue)

[ ] New feature (non-breaking change which adds functionality)

[ ] Documentation update

[ ] Refactoring, Maintenance

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

bug
opened by bjk7119 1
Modify help msg if invalid input
Description

Modify help msg if invalid input

Type of change

Please insert 'x' one of the type of change.

[ ] Bug fix (non-breaking change which fixes an issue)

[ ] New feature (non-breaking change which adds functionality)

[ ] Documentation update

[x] Refactoring, Maintenance

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

chore
opened by bjk7119 1
Change the required version of Python to 3.7
Description

Change the minimum required version of Python to 3.7.

Reason :

From ScanCode v31.0.1, Python 3.7+ is required. For this reason, the FOSSLight source scanner requires python 3.7.

Type of change

Please insert 'x' one of the type of change.

[ ] Bug fix (non-breaking change which fixes an issue)

[ ] New feature (non-breaking change which adds functionality)

[ ] Documentation update

[x] Refactoring, Maintenance

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

chore
opened by soimkim 1
Change FL Reuse to FL Prechecker
Description

Change FL Reuse to FL Prechecker

Type of change

Please insert 'x' one of the type of change.

[x] Bug fix (non-breaking change which fixes an issue)

[ ] New feature (non-breaking change which adds functionality)

[ ] Documentation update

[ ] Refactoring, Maintenance

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

bug fix
opened by bjk7119 1
Print message when comparison rows are over 100.
Signed-off-by: Jiyeong Seok [email protected]

Description

Print message when comparison rows are over 100.

Add progress bar

Type of change

Please insert 'x' one of the type of change.

[ ] Bug fix (non-breaking change which fixes an issue)

[x] New feature (non-breaking change which adds functionality)

[ ] Documentation update

[ ] Refactoring, Maintenance

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

chore
opened by dd-jy 1
Fix errors when parsing with path
Description

Fix the bug caused by not initializing the variable that outputs the default OSS Name.

Type of change

Please insert 'x' one of the type of change.

[x] Bug fix (non-breaking change which fixes an issue)

[ ] New feature (non-breaking change which adds functionality)

[ ] Documentation update

[ ] Refactoring, Maintenance

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

bug fix
opened by soimkim 1
Add a FOSSLight Binary
Description

Add the FOSSLight Binary to run during analysis.

Add the v option to print the version.

Type of change

Please insert 'x' one of the type of change.

[ ] Bug fix (non-breaking change which fixes an issue)

[ ] New feature (non-breaking change which adds functionality)

[ ] Documentation update

[x] Refactoring, Maintenance

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

enhancement
opened by soimkim 1
Add the -f option and change way to create output
Description

Add the -f option to input the output file format.

Change it to use FL Util's functions when generating output.

Input Mode

AS-IS: If user just type enter, it asks user to re-enter (try 2 times). Source and dependency path to be analyzed are inputted respectively.

TO-BE: If user just type enter in the input mode, it is assumed that nothing has been inputted. Source and dependency path to be analyzed is input at once.

Type of change

Please insert 'x' one of the type of change.

[ ] Bug fix (non-breaking change which fixes an issue)

[ ] New feature (non-breaking change which adds functionality)

[ ] Documentation update

[x] Refactoring, Maintenance

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

chore
opened by soimkim 1
An error occurs when FOSSLight Util is 1.2.0

Describe the bug An error occurs when FL Util is 1.2.0.

Expected behavior Specify the minimum version of FOSSLight Util required by FOSSLight Scanner.
bug

opened by soimkim 1

Releases(v1.7.8)

v1.7.8(Jan 2, 2023)
Changes

🔧 Maintenance

Update version of package for actions @bjk7119 (#54)

Source code(tar.gz)
Source code(zip)
v1.7.7(Nov 18, 2022)
Changes

🔧 Maintenance

Fix the output file msg if nothing scanned @dd-jy (#52)

Source code(tar.gz)
Source code(zip)
v1.7.6(Nov 4, 2022)
Changes

🐛 Hotfixes

Fix bug about dep. arg input when not dep. running @bjk7119 (#50)

🔧 Maintenance

Analyze current path if not input path @bjk7119 (#51)

Source code(tar.gz)
Source code(zip)
v1.7.5(Oct 6, 2022)
Changes

🔧 Maintenance

Fix the binary text copy issue @dd-jy (#49)

Source code(tar.gz)
Source code(zip)
v1.7.4(Sep 15, 2022)
Changes

🔧 Maintenance

Change the report file name @dd-jy (#48)

Modify help msg if invalid input @bjk7119 (#47)

Source code(tar.gz)
Source code(zip)
v1.7.3(Sep 1, 2022)
Changes

🚀 Features

Support 'xlsx' report for Compare mode @dd-jy (#46)

🔧 Maintenance

Change the required version of Python to 3.7 @soimkim (#45)

Source code(tar.gz)
Source code(zip)
v1.7.2(Aug 16, 2022)
Changes

🚀 Features

Support yaml format of FOSSLight Report @dd-jy (#42)

Source code(tar.gz)
Source code(zip)
v1.7.1(Jul 22, 2022)
Changes

🐛 Hotfixes

Change FL Reuse to FL Prechecker @bjk7119 (#43)

Source code(tar.gz)
Source code(zip)
v1.7.0(Jul 22, 2022)
Changes

🚀 Features

Add compare mode @dd-jy (#38)

🔧 Maintenance

Replace 'y' option to 'p' option. @dd-jy (#41)

Fix scanner support format and not to create csv. @dd-jy (#40)

Print message when comparison rows are over 100. @dd-jy (#39)

Source code(tar.gz)
Source code(zip)
v1.6.15(Jul 6, 2022)
Changes

🐛 Hotfixes

Modify reuse input parameter @bjk7119 (#37)

Source code(tar.gz)
Source code(zip)
v1.6.14(May 19, 2022)
Changes

🚀 Features

Run fosslight_source without installing it @soimkim (#34)

Add a Dockerfile @soimkim (#35)

🐛 Hotfixes

Fix a bug where part of the output file is not created without the -o option @soimkim (#36)

Source code(tar.gz)
Source code(zip)
v1.6.13(Apr 11, 2022)
Changes

🐛 Hotfixes

Fix an errors when parsing with path @soimkim (#33)

Fix an error that occur when downloading link @soimkim (#30)

🔧 Maintenance

Add a commit message checker @soimkim (#31)

Source code(tar.gz)
Source code(zip)
v1.6.12(Mar 28, 2022)
🐛 Hotfixes

Fix a bug where column names do not match when overwriting an excel @soimkim (#29)

Source code(tar.gz)
Source code(zip)
v1.6.11(Mar 27, 2022)
🚀 Features

Print download location when analyzing as link @soimkim (#28)

Extract the OSS name from the link @soimkim (#27)

Source code(tar.gz)
Source code(zip)
v1.6.10(Mar 11, 2022)
Changes

🔧 Maintenance

Apply f-string format @bjk7119 (#26)

Source code(tar.gz)
Source code(zip)
v1.6.9(Feb 28, 2022)
Changes

🔧 Maintenance

Change the result generation method to merging @soimkim (#25)

Add an inputable value to mode @soimkim (#24)

Update the README with additional Scanners @soimkim (#23)

Source code(tar.gz)
Source code(zip)
v1.6.8(Feb 10, 2022)
Changes

🚀 Features

Change the options when analyzing the source @soimkim (#19)

Support analysis mode @soimkim (#17)

Add a FOSSLight Reuse @soimkim (#16)

Add a FOSSLight Binary @soimkim (#14)

🐛 Hotfixes

Fix the bug that the raw folder is not deleted when analyzing with a link @soimkim (#21)

🔧 Maintenance

Modify to print output file name @bjk7119 (#22)

Create a result file of FOSSLight Source @soimkim (#20)

Move the binary analysis result file to output @soimkim (#18)

Source code(tar.gz)
Source code(zip)
v1.6.7(Nov 25, 2021)
Changes

🔧 Maintenance

Print output file instead of path @soimkim (#13)

Source code(tar.gz)
Source code(zip)
v1.6.6(Nov 4, 2021)
Changes

🚀 Features

Add number of process to analyze as parameter @soimkim (#11)

Source code(tar.gz)
Source code(zip)
v1.6.5(Oct 21, 2021)
Changes

🔧 Maintenance

Add the -f option and change way to create output @soimkim (#10)

Change the parameters related to the scanner path @soimkim (#9)

Source code(tar.gz)
Source code(zip)
v1.6.4(Oct 7, 2021)
Changes

🔧 Maintenance

Change sheet name of Dependency Scan result @soimkim (#8)

Source code(tar.gz)
Source code(zip)
v1.6.3(Oct 6, 2021)
Changes

🚀 Features

Add option -t for hiding the progress bar @soimkim (#7)

Source code(tar.gz)
Source code(zip)
v1.6.2(Oct 5, 2021)
Changes

🔧 Maintenance

Specify the output file name @soimkim (#6)

Source code(tar.gz)
Source code(zip)
v1.6.1(Oct 1, 2021)
Changes

🐛 Hotfixes

Add the FOSSLight Util minimum version @soimkim (#4)

🔧 Maintenance

Change the output path of log, source @soimkim (#5)

Source code(tar.gz)
Source code(zip)
v1.6.0(Sep 24, 2021)
Changes

🔧 Maintenance

Change the version related files @soimkim (#2)

Add copyright, license for Reuse compliance @soimkim (#1)

Source code(tar.gz)
Source code(zip)

Owner

FOSSLight

GitHub Repository

A python base script from which you can hack or clone any person's facebook friendlist or followers accounts which have simple password

Hcoder This is a python base script from which you can hack or clone any person's facebook friendlist or followers accounts which have simple password

3 Dec 06, 2021

FOSSLight Scanner performs open source analysis after downloading the source by passing a link that can be cloned by wget or git.

Related tags

Overview

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

Comments

Description

Type of change

Description

Type of change

Description

Type of change

Description

Type of change

Description

Type of change

Description

Type of change

Description

Type of change

Description

Type of change

Description

Type of change

Releases(v1.7.8)

v1.7.8(Jan 2, 2023)

Changes

🔧 Maintenance

v1.7.7(Nov 18, 2022)

Changes

🔧 Maintenance

v1.7.6(Nov 4, 2022)

Changes

🐛 Hotfixes

🔧 Maintenance

v1.7.5(Oct 6, 2022)

Changes

🔧 Maintenance

v1.7.4(Sep 15, 2022)

Changes

🔧 Maintenance

v1.7.3(Sep 1, 2022)

Changes

🚀 Features

🔧 Maintenance

v1.7.2(Aug 16, 2022)

Changes

🚀 Features

v1.7.1(Jul 22, 2022)

Changes

🐛 Hotfixes

v1.7.0(Jul 22, 2022)

Changes

🚀 Features

🔧 Maintenance

v1.6.15(Jul 6, 2022)

Changes

🐛 Hotfixes

v1.6.14(May 19, 2022)

Changes

🚀 Features

🐛 Hotfixes

v1.6.13(Apr 11, 2022)

Changes

🐛 Hotfixes

🔧 Maintenance

v1.6.12(Mar 28, 2022)

🐛 Hotfixes

v1.6.11(Mar 27, 2022)

🚀 Features

v1.6.10(Mar 11, 2022)