fosslight-scanner 2.1.7__tar.gz → 2.1.8__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. fosslight_scanner-2.1.8/PKG-INFO +174 -0
  2. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/README.md +2 -2
  3. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/setup.py +4 -5
  4. fosslight_scanner-2.1.8/src/fosslight_scanner.egg-info/PKG-INFO +174 -0
  5. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/src/fosslight_scanner.egg-info/entry_points.txt +0 -1
  6. fosslight_scanner-2.1.7/PKG-INFO +0 -175
  7. fosslight_scanner-2.1.7/src/fosslight_scanner.egg-info/PKG-INFO +0 -175
  8. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/LICENSE +0 -0
  9. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/MANIFEST.in +0 -0
  10. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/requirements.txt +0 -0
  11. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/setup.cfg +0 -0
  12. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/src/fosslight_scanner/__init__.py +0 -0
  13. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/src/fosslight_scanner/_get_input.py +0 -0
  14. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/src/fosslight_scanner/_help.py +0 -0
  15. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/src/fosslight_scanner/_parse_setting.py +0 -0
  16. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/src/fosslight_scanner/_run_compare.py +0 -0
  17. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/src/fosslight_scanner/cli.py +0 -0
  18. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/src/fosslight_scanner/common.py +0 -0
  19. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/src/fosslight_scanner/fosslight_scanner.py +0 -0
  20. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/src/fosslight_scanner/resources/bom_compare.html +0 -0
  21. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/src/fosslight_scanner.egg-info/SOURCES.txt +0 -0
  22. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/src/fosslight_scanner.egg-info/dependency_links.txt +0 -0
  23. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/src/fosslight_scanner.egg-info/requires.txt +0 -0
  24. {fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/src/fosslight_scanner.egg-info/top_level.txt +0 -0
fosslight_scanner-2.1.8/PKG-INFO ADDED
@@ -0,0 +1,174 @@
1
+ Metadata-Version: 2.1
2
+ Name: fosslight_scanner
3
+ Version: 2.1.8
4
+ Summary: FOSSLight Scanner
5
+ Home-page: https://github.com/fosslight/fosslight_scanner
6
+ Download-URL: https://github.com/fosslight/fosslight_scanner
7
+ Author: LG Electronics
8
+ License: Apache-2.0
9
+ Classifier: License :: OSI Approved :: Apache Software License
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Programming Language :: Python :: 3.10
12
+ Classifier: Programming Language :: Python :: 3.11
13
+ Classifier: Programming Language :: Python :: 3.12
14
+ Requires-Python: >=3.10,<3.13
15
+ Description-Content-Type: text/markdown
16
+ License-File: LICENSE
17
+
18
+ <!--
19
+ Copyright (c) 2021 LG Electronics
20
+ SPDX-License-Identifier: Apache-2.0
21
+ -->
22
+
23
+ # FOSSLight Scanner
24
+ <strong>Analyze at once for Open Source Compliance.</strong><br>
25
+
26
+ <img src="https://img.shields.io/pypi/l/fosslight_scanner" alt="FOSSLight Scanner is released under the Apache-2.0." /> <img src="https://img.shields.io/pypi/v/fosslight_scanner" alt="Current python package version." /> <img src="https://img.shields.io/pypi/pyversions/fosslight_scanner" /> [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_scanner)](https://api.reuse.software/info/github.com/fosslight/fosslight_scanner)
27
+
28
+
29
+ **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][or] format.
30
+
31
+ - **[FOSSLight Prechecker][re]** Check whether the [source code's copyright and license writing rules][rule] are complied with.
32
+ - **[FOSSLight Source Scanner][s]** Extract license and copyright in the source code using [ScanCode][sc].
33
+ - **[FOSSLight Dependency Scanner][d]** Extract dependency and OSS information from the package manager's manifest file.
34
+ - **[FOSSLight Binary Scanner][flbin]** Find binary and print OSS information.
35
+
36
+ [s]: https://github.com/fosslight/fosslight_source_scanner
37
+ [d]: https://github.com/fosslight/fosslight_dependency_scanner
38
+ [sc]: https://github.com/nexB/scancode-toolkit
39
+ [or]: https://fosslight.org/fosslight-guide-en/learn/2_fosslight_report.html
40
+ [flbin]: https://github.com/fosslight/fosslight_binary_scanner
41
+ [re]: https://github.com/fosslight/fosslight_prechecker
42
+ [rule]: https://oss.lge.com/guide/process/osc_process/1-identification/copyright_license_rule.html
43
+
44
+ ## Contents
45
+
46
+ - [FOSSLight Scanner](#fosslight-scanner)
47
+ - [Contents](#contents)
48
+ - [📋 Prerequisite](#-prerequisite)
49
+ - [🎉 How to install](#-how-to-install)
50
+ - [🚀 How to run](#-how-to-run)
51
+ - [Parameters](#parameters)
52
+ - [Ex 1. Local Source Analysis](#ex-1-local-source-analysis)
53
+ - [Ex 2. Download Link and analyze](#ex-2-download-link-and-analyze)
54
+ - [📁 Result](#-result)
55
+ - [🐳 How to run using Docker](#-how-to-run-using-docker)
56
+ - [👏 How to report issue](#-how-to-report-issue)
57
+ - [📄 License](#-license)
58
+
59
+
60
+ ## 📋 Prerequisite
61
+
62
+ FOSSLight Scanner needs a Python 3.10+.
63
+
64
+ ## 🎉 How to install
65
+
66
+
67
+ It can be installed using pip3. It is recommended to install it in the [virtualenv]([etc/guide_virtualenv.md](https://fosslight.org/fosslight-guide-en/scanner/etc/guide_virtualenv.html)) environment.
68
+
69
+ ```
70
+ $ pip3 install fosslight_scanner
71
+ ```
72
+
73
+ ## 🚀 How to run
74
+
75
+ FOSSLight Scanner is run with the **fosslight** command.
76
+ ```
77
+ fosslight [Mode] [option1] <arg1> [option2] <arg2>...
78
+ ```
79
+ ### Parameters
80
+ Mode
81
+ ```
82
+ all Run all scanners(Default)
83
+ source Run FOSSLight Source
84
+ dependency Run FOSSLight Dependency
85
+ binary Run FOSSLight Binary
86
+ prechecker Run FOSSLight Prechecker
87
+ compare Compare two FOSSLight reports
88
+ ```
89
+ Options:
90
+ ```
91
+ -h Print help message
92
+ -p <path> Path to analyze (ex, -p {input_path})
93
+ * Compare mode input file: Two FOSSLight reports (supports excel, yaml)
94
+ (ex, -p {before_name}.xlsx {after_name}.xlsx)
95
+ -w <link> Link to be analyzed can be downloaded by wget or git clone
96
+ -f <format> FOSSLight Report file format (excel, yaml)
97
+ * Compare mode result file: supports excel, json, yaml, html
98
+ -o <output> Output directory or file
99
+ -c <number> Number of processes to analyze source
100
+ -e <path> Path to exclude from analysis (ex, -e {dir} {file})
101
+ -r Keep raw data
102
+ -t Hide the progress bar
103
+ -v Print FOSSLight Scanner version
104
+ -s <path> Path to apply setting from json file (check format with 'setting.json' in this repository)
105
+ * Direct cli flags have higher priority than setting file
106
+ (ex, '-f yaml -s setting.json' - result file extension is .yaml)
107
+ ```
108
+ - Refs.
109
+ - Additional arguments for running dependency analysis. See the [FOSSLight Dependency Guide][fd_guide] for instructions.
110
+ - In the case of DB URL, it is the [DB connection information to be used in FOSSLight Binary][flbindb].
111
+
112
+ [flbindb]: https://fosslight.org/fosslight-guide-en/scanner/etc/binary_db.html
113
+ [fd_guide]: https://fosslight.org/fosslight-guide-en/scanner/2_dependency.html
114
+
115
+ ### Ex 1. Local Source Analysis
116
+ ```
117
+ $ fosslight all -p /home/source_path -d "-a 'source /test/Projects/venv/bin/activate' -d 'deactivate'"
118
+ ```
119
+
120
+ ### Ex 2. Local Source Analysis with Path to Exclude
121
+ ```
122
+ $ fosslight all -p /home/source_path -e temp_dir src/temp.py
123
+ ```
124
+
125
+ ### Ex 3. Download Link and analyze
126
+ ```
127
+ $ fosslight all -o test_result_wget -w "https://github.com/LGE-OSS/example.git"
128
+ ```
129
+ If you want to analyze private repository, set your github token like below.
130
+ ```
131
+ $ fosslight all -w "https://my_github_token@github.com/Foo/private_repo
132
+ ```
133
+
134
+ ### Ex 4. Compare the BOM of two FOSSLight reports with yaml or excel format and check the oss status (change/add/delete)
135
+ ```
136
+ $ fosslight compare -p FOSSLight_before_proj.yaml FOSSLight_after_proj.yaml -f excel
137
+ ```
138
+
139
+ ## 📁 Result
140
+
141
+ ```
142
+ $ tree
143
+ .
144
+ ├── fosslight_log
145
+ │   ├── fosslight_log_20210924_022422.txt
146
+ └── FOSSLight-Report_20210924_022422.xlsx
147
+ ```
148
+
149
+ - FOSSLight_Report-[datetime].xlsx : OSS Report format file that outputs source code analysis, binary analysis, and dependency analysis results.
150
+ - fosslight_raw_data_[datetime] directory: Directory in which raw data files are created as a result of analysis
151
+
152
+ ## 🐳 How to run using Docker
153
+ 1. Build image using Dockerfile.
154
+ ```
155
+ $docker build -t fosslight .
156
+ ```
157
+ 2. Run with the image you built.
158
+ ex. Output: /Users/fosslight_source_scanner/test_output, Path to be analyzed: tests/test_files
159
+ ```
160
+ $docker run -it -v /Users/fosslight_source_scanner/test_output:/app/output fosslight -p tests/test_files -o output
161
+ ```
162
+
163
+ ## 👏 How to report issue
164
+
165
+ Please report any ideas or bugs to improve by creating an issue in [fosslight_scanner repository][cl].
166
+ Then there will be quick bug fixes and upgrades. Ideas to improve are always welcome.
167
+
168
+ [cl]: https://github.com/fosslight/fosslight_scanner/issues
169
+
170
+ ## 📄 License
171
+
172
+ FOSSLight Scanner is released under [Apache-2.0][l].
173
+
174
+ [l]: https://github.com/fosslight/fosslight_scanner/blob/main/LICENSE
{fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/README.md RENAMED
@@ -42,12 +42,12 @@ SPDX-License-Identifier: Apache-2.0
42
42
 
43
43
  ## 📋 Prerequisite
44
44
 
45
- FOSSLight Scanner needs a Python 3.6+.
45
+ FOSSLight Scanner needs a Python 3.10+.
46
46
 
47
47
  ## 🎉 How to install
48
48
 
49
49
 
50
- It can be installed using pip3. It is recommended to install it in the [python 3.7 + virtualenv]([etc/guide_virtualenv.md](https://fosslight.org/fosslight-guide-en/scanner/etc/guide_virtualenv.html)) environment.
50
+ It can be installed using pip3. It is recommended to install it in the [virtualenv]([etc/guide_virtualenv.md](https://fosslight.org/fosslight-guide-en/scanner/etc/guide_virtualenv.html)) environment.
51
51
 
52
52
  ```
53
53
  $ pip3 install fosslight_scanner
{fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/setup.py RENAMED
@@ -15,7 +15,7 @@ with open('requirements.txt', 'r', 'utf-8') as f:
15
15
  if __name__ == "__main__":
16
16
  setup(
17
17
  name='fosslight_scanner',
18
- version='2.1.7',
18
+ version='2.1.8',
19
19
  package_dir={"": "src"},
20
20
  packages=find_packages(where='src'),
21
21
  description='FOSSLight Scanner',
@@ -27,11 +27,10 @@ if __name__ == "__main__":
27
27
  download_url='https://github.com/fosslight/fosslight_scanner',
28
28
  classifiers=['License :: OSI Approved :: Apache Software License',
29
29
  "Programming Language :: Python :: 3",
30
- "Programming Language :: Python :: 3.8",
31
- "Programming Language :: Python :: 3.9",
32
30
  "Programming Language :: Python :: 3.10",
33
- "Programming Language :: Python :: 3.11", ],
34
- python_requires=">=3.8",
31
+ "Programming Language :: Python :: 3.11",
32
+ "Programming Language :: Python :: 3.12", ],
33
+ python_requires='>=3.10,<3.13',
35
34
  install_requires=required,
36
35
  package_data={'fosslight_scanner': ['resources/bom_compare.html']},
37
36
  entry_points={
fosslight_scanner-2.1.8/src/fosslight_scanner.egg-info/PKG-INFO ADDED
@@ -0,0 +1,174 @@
1
+ Metadata-Version: 2.1
2
+ Name: fosslight-scanner
3
+ Version: 2.1.8
4
+ Summary: FOSSLight Scanner
5
+ Home-page: https://github.com/fosslight/fosslight_scanner
6
+ Download-URL: https://github.com/fosslight/fosslight_scanner
7
+ Author: LG Electronics
8
+ License: Apache-2.0
9
+ Classifier: License :: OSI Approved :: Apache Software License
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Programming Language :: Python :: 3.10
12
+ Classifier: Programming Language :: Python :: 3.11
13
+ Classifier: Programming Language :: Python :: 3.12
14
+ Requires-Python: >=3.10,<3.13
15
+ Description-Content-Type: text/markdown
16
+ License-File: LICENSE
17
+
18
+ <!--
19
+ Copyright (c) 2021 LG Electronics
20
+ SPDX-License-Identifier: Apache-2.0
21
+ -->
22
+
23
+ # FOSSLight Scanner
24
+ <strong>Analyze at once for Open Source Compliance.</strong><br>
25
+
26
+ <img src="https://img.shields.io/pypi/l/fosslight_scanner" alt="FOSSLight Scanner is released under the Apache-2.0." /> <img src="https://img.shields.io/pypi/v/fosslight_scanner" alt="Current python package version." /> <img src="https://img.shields.io/pypi/pyversions/fosslight_scanner" /> [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_scanner)](https://api.reuse.software/info/github.com/fosslight/fosslight_scanner)
27
+
28
+
29
+ **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][or] format.
30
+
31
+ - **[FOSSLight Prechecker][re]** Check whether the [source code's copyright and license writing rules][rule] are complied with.
32
+ - **[FOSSLight Source Scanner][s]** Extract license and copyright in the source code using [ScanCode][sc].
33
+ - **[FOSSLight Dependency Scanner][d]** Extract dependency and OSS information from the package manager's manifest file.
34
+ - **[FOSSLight Binary Scanner][flbin]** Find binary and print OSS information.
35
+
36
+ [s]: https://github.com/fosslight/fosslight_source_scanner
37
+ [d]: https://github.com/fosslight/fosslight_dependency_scanner
38
+ [sc]: https://github.com/nexB/scancode-toolkit
39
+ [or]: https://fosslight.org/fosslight-guide-en/learn/2_fosslight_report.html
40
+ [flbin]: https://github.com/fosslight/fosslight_binary_scanner
41
+ [re]: https://github.com/fosslight/fosslight_prechecker
42
+ [rule]: https://oss.lge.com/guide/process/osc_process/1-identification/copyright_license_rule.html
43
+
44
+ ## Contents
45
+
46
+ - [FOSSLight Scanner](#fosslight-scanner)
47
+ - [Contents](#contents)
48
+ - [📋 Prerequisite](#-prerequisite)
49
+ - [🎉 How to install](#-how-to-install)
50
+ - [🚀 How to run](#-how-to-run)
51
+ - [Parameters](#parameters)
52
+ - [Ex 1. Local Source Analysis](#ex-1-local-source-analysis)
53
+ - [Ex 2. Download Link and analyze](#ex-2-download-link-and-analyze)
54
+ - [📁 Result](#-result)
55
+ - [🐳 How to run using Docker](#-how-to-run-using-docker)
56
+ - [👏 How to report issue](#-how-to-report-issue)
57
+ - [📄 License](#-license)
58
+
59
+
60
+ ## 📋 Prerequisite
61
+
62
+ FOSSLight Scanner needs a Python 3.10+.
63
+
64
+ ## 🎉 How to install
65
+
66
+
67
+ It can be installed using pip3. It is recommended to install it in the [virtualenv]([etc/guide_virtualenv.md](https://fosslight.org/fosslight-guide-en/scanner/etc/guide_virtualenv.html)) environment.
68
+
69
+ ```
70
+ $ pip3 install fosslight_scanner
71
+ ```
72
+
73
+ ## 🚀 How to run
74
+
75
+ FOSSLight Scanner is run with the **fosslight** command.
76
+ ```
77
+ fosslight [Mode] [option1] <arg1> [option2] <arg2>...
78
+ ```
79
+ ### Parameters
80
+ Mode
81
+ ```
82
+ all Run all scanners(Default)
83
+ source Run FOSSLight Source
84
+ dependency Run FOSSLight Dependency
85
+ binary Run FOSSLight Binary
86
+ prechecker Run FOSSLight Prechecker
87
+ compare Compare two FOSSLight reports
88
+ ```
89
+ Options:
90
+ ```
91
+ -h Print help message
92
+ -p <path> Path to analyze (ex, -p {input_path})
93
+ * Compare mode input file: Two FOSSLight reports (supports excel, yaml)
94
+ (ex, -p {before_name}.xlsx {after_name}.xlsx)
95
+ -w <link> Link to be analyzed can be downloaded by wget or git clone
96
+ -f <format> FOSSLight Report file format (excel, yaml)
97
+ * Compare mode result file: supports excel, json, yaml, html
98
+ -o <output> Output directory or file
99
+ -c <number> Number of processes to analyze source
100
+ -e <path> Path to exclude from analysis (ex, -e {dir} {file})
101
+ -r Keep raw data
102
+ -t Hide the progress bar
103
+ -v Print FOSSLight Scanner version
104
+ -s <path> Path to apply setting from json file (check format with 'setting.json' in this repository)
105
+ * Direct cli flags have higher priority than setting file
106
+ (ex, '-f yaml -s setting.json' - result file extension is .yaml)
107
+ ```
108
+ - Refs.
109
+ - Additional arguments for running dependency analysis. See the [FOSSLight Dependency Guide][fd_guide] for instructions.
110
+ - In the case of DB URL, it is the [DB connection information to be used in FOSSLight Binary][flbindb].
111
+
112
+ [flbindb]: https://fosslight.org/fosslight-guide-en/scanner/etc/binary_db.html
113
+ [fd_guide]: https://fosslight.org/fosslight-guide-en/scanner/2_dependency.html
114
+
115
+ ### Ex 1. Local Source Analysis
116
+ ```
117
+ $ fosslight all -p /home/source_path -d "-a 'source /test/Projects/venv/bin/activate' -d 'deactivate'"
118
+ ```
119
+
120
+ ### Ex 2. Local Source Analysis with Path to Exclude
121
+ ```
122
+ $ fosslight all -p /home/source_path -e temp_dir src/temp.py
123
+ ```
124
+
125
+ ### Ex 3. Download Link and analyze
126
+ ```
127
+ $ fosslight all -o test_result_wget -w "https://github.com/LGE-OSS/example.git"
128
+ ```
129
+ If you want to analyze private repository, set your github token like below.
130
+ ```
131
+ $ fosslight all -w "https://my_github_token@github.com/Foo/private_repo
132
+ ```
133
+
134
+ ### Ex 4. Compare the BOM of two FOSSLight reports with yaml or excel format and check the oss status (change/add/delete)
135
+ ```
136
+ $ fosslight compare -p FOSSLight_before_proj.yaml FOSSLight_after_proj.yaml -f excel
137
+ ```
138
+
139
+ ## 📁 Result
140
+
141
+ ```
142
+ $ tree
143
+ .
144
+ ├── fosslight_log
145
+ │   ├── fosslight_log_20210924_022422.txt
146
+ └── FOSSLight-Report_20210924_022422.xlsx
147
+ ```
148
+
149
+ - FOSSLight_Report-[datetime].xlsx : OSS Report format file that outputs source code analysis, binary analysis, and dependency analysis results.
150
+ - fosslight_raw_data_[datetime] directory: Directory in which raw data files are created as a result of analysis
151
+
152
+ ## 🐳 How to run using Docker
153
+ 1. Build image using Dockerfile.
154
+ ```
155
+ $docker build -t fosslight .
156
+ ```
157
+ 2. Run with the image you built.
158
+ ex. Output: /Users/fosslight_source_scanner/test_output, Path to be analyzed: tests/test_files
159
+ ```
160
+ $docker run -it -v /Users/fosslight_source_scanner/test_output:/app/output fosslight -p tests/test_files -o output
161
+ ```
162
+
163
+ ## 👏 How to report issue
164
+
165
+ Please report any ideas or bugs to improve by creating an issue in [fosslight_scanner repository][cl].
166
+ Then there will be quick bug fixes and upgrades. Ideas to improve are always welcome.
167
+
168
+ [cl]: https://github.com/fosslight/fosslight_scanner/issues
169
+
170
+ ## 📄 License
171
+
172
+ FOSSLight Scanner is released under [Apache-2.0][l].
173
+
174
+ [l]: https://github.com/fosslight/fosslight_scanner/blob/main/LICENSE
{fosslight_scanner-2.1.7 → fosslight_scanner-2.1.8}/src/fosslight_scanner.egg-info/entry_points.txt RENAMED
@@ -1,4 +1,3 @@
1
1
  [console_scripts]
2
2
  fosslight = fosslight_scanner.cli:main
3
3
  fosslight_scanner = fosslight_scanner.cli:main
4
-
fosslight_scanner-2.1.7/PKG-INFO DELETED
@@ -1,175 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: fosslight_scanner
3
- Version: 2.1.7
4
- Summary: FOSSLight Scanner
5
- Home-page: https://github.com/fosslight/fosslight_scanner
6
- Author: LG Electronics
7
- License: Apache-2.0
8
- Download-URL: https://github.com/fosslight/fosslight_scanner
9
- Description: <!--
10
- Copyright (c) 2021 LG Electronics
11
- SPDX-License-Identifier: Apache-2.0
12
- -->
13
-
14
- # FOSSLight Scanner
15
- <strong>Analyze at once for Open Source Compliance.</strong><br>
16
-
17
- <img src="https://img.shields.io/pypi/l/fosslight_scanner" alt="FOSSLight Scanner is released under the Apache-2.0." /> <img src="https://img.shields.io/pypi/v/fosslight_scanner" alt="Current python package version." /> <img src="https://img.shields.io/pypi/pyversions/fosslight_scanner" /> [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_scanner)](https://api.reuse.software/info/github.com/fosslight/fosslight_scanner)
18
-
19
-
20
- **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][or] format.
21
-
22
- - **[FOSSLight Prechecker][re]** Check whether the [source code's copyright and license writing rules][rule] are complied with.
23
- - **[FOSSLight Source Scanner][s]** Extract license and copyright in the source code using [ScanCode][sc].
24
- - **[FOSSLight Dependency Scanner][d]** Extract dependency and OSS information from the package manager's manifest file.
25
- - **[FOSSLight Binary Scanner][flbin]** Find binary and print OSS information.
26
-
27
- [s]: https://github.com/fosslight/fosslight_source_scanner
28
- [d]: https://github.com/fosslight/fosslight_dependency_scanner
29
- [sc]: https://github.com/nexB/scancode-toolkit
30
- [or]: https://fosslight.org/fosslight-guide-en/learn/2_fosslight_report.html
31
- [flbin]: https://github.com/fosslight/fosslight_binary_scanner
32
- [re]: https://github.com/fosslight/fosslight_prechecker
33
- [rule]: https://oss.lge.com/guide/process/osc_process/1-identification/copyright_license_rule.html
34
-
35
- ## Contents
36
-
37
- - [FOSSLight Scanner](#fosslight-scanner)
38
- - [Contents](#contents)
39
- - [📋 Prerequisite](#-prerequisite)
40
- - [🎉 How to install](#-how-to-install)
41
- - [🚀 How to run](#-how-to-run)
42
- - [Parameters](#parameters)
43
- - [Ex 1. Local Source Analysis](#ex-1-local-source-analysis)
44
- - [Ex 2. Download Link and analyze](#ex-2-download-link-and-analyze)
45
- - [📁 Result](#-result)
46
- - [🐳 How to run using Docker](#-how-to-run-using-docker)
47
- - [👏 How to report issue](#-how-to-report-issue)
48
- - [📄 License](#-license)
49
-
50
-
51
- ## 📋 Prerequisite
52
-
53
- FOSSLight Scanner needs a Python 3.6+.
54
-
55
- ## 🎉 How to install
56
-
57
-
58
- It can be installed using pip3. It is recommended to install it in the [python 3.7 + virtualenv]([etc/guide_virtualenv.md](https://fosslight.org/fosslight-guide-en/scanner/etc/guide_virtualenv.html)) environment.
59
-
60
- ```
61
- $ pip3 install fosslight_scanner
62
- ```
63
-
64
- ## 🚀 How to run
65
-
66
- FOSSLight Scanner is run with the **fosslight** command.
67
- ```
68
- fosslight [Mode] [option1] <arg1> [option2] <arg2>...
69
- ```
70
- ### Parameters
71
- Mode
72
- ```
73
- all Run all scanners(Default)
74
- source Run FOSSLight Source
75
- dependency Run FOSSLight Dependency
76
- binary Run FOSSLight Binary
77
- prechecker Run FOSSLight Prechecker
78
- compare Compare two FOSSLight reports
79
- ```
80
- Options:
81
- ```
82
- -h Print help message
83
- -p <path> Path to analyze (ex, -p {input_path})
84
- * Compare mode input file: Two FOSSLight reports (supports excel, yaml)
85
- (ex, -p {before_name}.xlsx {after_name}.xlsx)
86
- -w <link> Link to be analyzed can be downloaded by wget or git clone
87
- -f <format> FOSSLight Report file format (excel, yaml)
88
- * Compare mode result file: supports excel, json, yaml, html
89
- -o <output> Output directory or file
90
- -c <number> Number of processes to analyze source
91
- -e <path> Path to exclude from analysis (ex, -e {dir} {file})
92
- -r Keep raw data
93
- -t Hide the progress bar
94
- -v Print FOSSLight Scanner version
95
- -s <path> Path to apply setting from json file (check format with 'setting.json' in this repository)
96
- * Direct cli flags have higher priority than setting file
97
- (ex, '-f yaml -s setting.json' - result file extension is .yaml)
98
- ```
99
- - Refs.
100
- - Additional arguments for running dependency analysis. See the [FOSSLight Dependency Guide][fd_guide] for instructions.
101
- - In the case of DB URL, it is the [DB connection information to be used in FOSSLight Binary][flbindb].
102
-
103
- [flbindb]: https://fosslight.org/fosslight-guide-en/scanner/etc/binary_db.html
104
- [fd_guide]: https://fosslight.org/fosslight-guide-en/scanner/2_dependency.html
105
-
106
- ### Ex 1. Local Source Analysis
107
- ```
108
- $ fosslight all -p /home/source_path -d "-a 'source /test/Projects/venv/bin/activate' -d 'deactivate'"
109
- ```
110
-
111
- ### Ex 2. Local Source Analysis with Path to Exclude
112
- ```
113
- $ fosslight all -p /home/source_path -e temp_dir src/temp.py
114
- ```
115
-
116
- ### Ex 3. Download Link and analyze
117
- ```
118
- $ fosslight all -o test_result_wget -w "https://github.com/LGE-OSS/example.git"
119
- ```
120
- If you want to analyze private repository, set your github token like below.
121
- ```
122
- $ fosslight all -w "https://my_github_token@github.com/Foo/private_repo
123
- ```
124
-
125
- ### Ex 4. Compare the BOM of two FOSSLight reports with yaml or excel format and check the oss status (change/add/delete)
126
- ```
127
- $ fosslight compare -p FOSSLight_before_proj.yaml FOSSLight_after_proj.yaml -f excel
128
- ```
129
-
130
- ## 📁 Result
131
-
132
- ```
133
- $ tree
134
- .
135
- ├── fosslight_log
136
- │   ├── fosslight_log_20210924_022422.txt
137
- └── FOSSLight-Report_20210924_022422.xlsx
138
- ```
139
-
140
- - FOSSLight_Report-[datetime].xlsx : OSS Report format file that outputs source code analysis, binary analysis, and dependency analysis results.
141
- - fosslight_raw_data_[datetime] directory: Directory in which raw data files are created as a result of analysis
142
-
143
- ## 🐳 How to run using Docker
144
- 1. Build image using Dockerfile.
145
- ```
146
- $docker build -t fosslight .
147
- ```
148
- 2. Run with the image you built.
149
- ex. Output: /Users/fosslight_source_scanner/test_output, Path to be analyzed: tests/test_files
150
- ```
151
- $docker run -it -v /Users/fosslight_source_scanner/test_output:/app/output fosslight -p tests/test_files -o output
152
- ```
153
-
154
- ## 👏 How to report issue
155
-
156
- Please report any ideas or bugs to improve by creating an issue in [fosslight_scanner repository][cl].
157
- Then there will be quick bug fixes and upgrades. Ideas to improve are always welcome.
158
-
159
- [cl]: https://github.com/fosslight/fosslight_scanner/issues
160
-
161
- ## 📄 License
162
-
163
- FOSSLight Scanner is released under [Apache-2.0][l].
164
-
165
- [l]: https://github.com/fosslight/fosslight_scanner/blob/main/LICENSE
166
-
167
- Platform: UNKNOWN
168
- Classifier: License :: OSI Approved :: Apache Software License
169
- Classifier: Programming Language :: Python :: 3
170
- Classifier: Programming Language :: Python :: 3.8
171
- Classifier: Programming Language :: Python :: 3.9
172
- Classifier: Programming Language :: Python :: 3.10
173
- Classifier: Programming Language :: Python :: 3.11
174
- Requires-Python: >=3.8
175
- Description-Content-Type: text/markdown
fosslight_scanner-2.1.7/src/fosslight_scanner.egg-info/PKG-INFO DELETED
@@ -1,175 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: fosslight-scanner
3
- Version: 2.1.7
4
- Summary: FOSSLight Scanner
5
- Home-page: https://github.com/fosslight/fosslight_scanner
6
- Author: LG Electronics
7
- License: Apache-2.0
8
- Download-URL: https://github.com/fosslight/fosslight_scanner
9
- Description: <!--
10
- Copyright (c) 2021 LG Electronics
11
- SPDX-License-Identifier: Apache-2.0
12
- -->
13
-
14
- # FOSSLight Scanner
15
- <strong>Analyze at once for Open Source Compliance.</strong><br>
16
-
17
- <img src="https://img.shields.io/pypi/l/fosslight_scanner" alt="FOSSLight Scanner is released under the Apache-2.0." /> <img src="https://img.shields.io/pypi/v/fosslight_scanner" alt="Current python package version." /> <img src="https://img.shields.io/pypi/pyversions/fosslight_scanner" /> [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_scanner)](https://api.reuse.software/info/github.com/fosslight/fosslight_scanner)
18
-
19
-
20
- **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][or] format.
21
-
22
- - **[FOSSLight Prechecker][re]** Check whether the [source code's copyright and license writing rules][rule] are complied with.
23
- - **[FOSSLight Source Scanner][s]** Extract license and copyright in the source code using [ScanCode][sc].
24
- - **[FOSSLight Dependency Scanner][d]** Extract dependency and OSS information from the package manager's manifest file.
25
- - **[FOSSLight Binary Scanner][flbin]** Find binary and print OSS information.
26
-
27
- [s]: https://github.com/fosslight/fosslight_source_scanner
28
- [d]: https://github.com/fosslight/fosslight_dependency_scanner
29
- [sc]: https://github.com/nexB/scancode-toolkit
30
- [or]: https://fosslight.org/fosslight-guide-en/learn/2_fosslight_report.html
31
- [flbin]: https://github.com/fosslight/fosslight_binary_scanner
32
- [re]: https://github.com/fosslight/fosslight_prechecker
33
- [rule]: https://oss.lge.com/guide/process/osc_process/1-identification/copyright_license_rule.html
34
-
35
- ## Contents
36
-
37
- - [FOSSLight Scanner](#fosslight-scanner)
38
- - [Contents](#contents)
39
- - [📋 Prerequisite](#-prerequisite)
40
- - [🎉 How to install](#-how-to-install)
41
- - [🚀 How to run](#-how-to-run)
42
- - [Parameters](#parameters)
43
- - [Ex 1. Local Source Analysis](#ex-1-local-source-analysis)
44
- - [Ex 2. Download Link and analyze](#ex-2-download-link-and-analyze)
45
- - [📁 Result](#-result)
46
- - [🐳 How to run using Docker](#-how-to-run-using-docker)
47
- - [👏 How to report issue](#-how-to-report-issue)
48
- - [📄 License](#-license)
49
-
50
-
51
- ## 📋 Prerequisite
52
-
53
- FOSSLight Scanner needs a Python 3.6+.
54
-
55
- ## 🎉 How to install
56
-
57
-
58
- It can be installed using pip3. It is recommended to install it in the [python 3.7 + virtualenv]([etc/guide_virtualenv.md](https://fosslight.org/fosslight-guide-en/scanner/etc/guide_virtualenv.html)) environment.
59
-
60
- ```
61
- $ pip3 install fosslight_scanner
62
- ```
63
-
64
- ## 🚀 How to run
65
-
66
- FOSSLight Scanner is run with the **fosslight** command.
67
- ```
68
- fosslight [Mode] [option1] <arg1> [option2] <arg2>...
69
- ```
70
- ### Parameters
71
- Mode
72
- ```
73
- all Run all scanners(Default)
74
- source Run FOSSLight Source
75
- dependency Run FOSSLight Dependency
76
- binary Run FOSSLight Binary
77
- prechecker Run FOSSLight Prechecker
78
- compare Compare two FOSSLight reports
79
- ```
80
- Options:
81
- ```
82
- -h Print help message
83
- -p <path> Path to analyze (ex, -p {input_path})
84
- * Compare mode input file: Two FOSSLight reports (supports excel, yaml)
85
- (ex, -p {before_name}.xlsx {after_name}.xlsx)
86
- -w <link> Link to be analyzed can be downloaded by wget or git clone
87
- -f <format> FOSSLight Report file format (excel, yaml)
88
- * Compare mode result file: supports excel, json, yaml, html
89
- -o <output> Output directory or file
90
- -c <number> Number of processes to analyze source
91
- -e <path> Path to exclude from analysis (ex, -e {dir} {file})
92
- -r Keep raw data
93
- -t Hide the progress bar
94
- -v Print FOSSLight Scanner version
95
- -s <path> Path to apply setting from json file (check format with 'setting.json' in this repository)
96
- * Direct cli flags have higher priority than setting file
97
- (ex, '-f yaml -s setting.json' - result file extension is .yaml)
98
- ```
99
- - Refs.
100
- - Additional arguments for running dependency analysis. See the [FOSSLight Dependency Guide][fd_guide] for instructions.
101
- - In the case of DB URL, it is the [DB connection information to be used in FOSSLight Binary][flbindb].
102
-
103
- [flbindb]: https://fosslight.org/fosslight-guide-en/scanner/etc/binary_db.html
104
- [fd_guide]: https://fosslight.org/fosslight-guide-en/scanner/2_dependency.html
105
-
106
- ### Ex 1. Local Source Analysis
107
- ```
108
- $ fosslight all -p /home/source_path -d "-a 'source /test/Projects/venv/bin/activate' -d 'deactivate'"
109
- ```
110
-
111
- ### Ex 2. Local Source Analysis with Path to Exclude
112
- ```
113
- $ fosslight all -p /home/source_path -e temp_dir src/temp.py
114
- ```
115
-
116
- ### Ex 3. Download Link and analyze
117
- ```
118
- $ fosslight all -o test_result_wget -w "https://github.com/LGE-OSS/example.git"
119
- ```
120
- If you want to analyze private repository, set your github token like below.
121
- ```
122
- $ fosslight all -w "https://my_github_token@github.com/Foo/private_repo
123
- ```
124
-
125
- ### Ex 4. Compare the BOM of two FOSSLight reports with yaml or excel format and check the oss status (change/add/delete)
126
- ```
127
- $ fosslight compare -p FOSSLight_before_proj.yaml FOSSLight_after_proj.yaml -f excel
128
- ```
129
-
130
- ## 📁 Result
131
-
132
- ```
133
- $ tree
134
- .
135
- ├── fosslight_log
136
- │   ├── fosslight_log_20210924_022422.txt
137
- └── FOSSLight-Report_20210924_022422.xlsx
138
- ```
139
-
140
- - FOSSLight_Report-[datetime].xlsx : OSS Report format file that outputs source code analysis, binary analysis, and dependency analysis results.
141
- - fosslight_raw_data_[datetime] directory: Directory in which raw data files are created as a result of analysis
142
-
143
- ## 🐳 How to run using Docker
144
- 1. Build image using Dockerfile.
145
- ```
146
- $docker build -t fosslight .
147
- ```
148
- 2. Run with the image you built.
149
- ex. Output: /Users/fosslight_source_scanner/test_output, Path to be analyzed: tests/test_files
150
- ```
151
- $docker run -it -v /Users/fosslight_source_scanner/test_output:/app/output fosslight -p tests/test_files -o output
152
- ```
153
-
154
- ## 👏 How to report issue
155
-
156
- Please report any ideas or bugs to improve by creating an issue in [fosslight_scanner repository][cl].
157
- Then there will be quick bug fixes and upgrades. Ideas to improve are always welcome.
158
-
159
- [cl]: https://github.com/fosslight/fosslight_scanner/issues
160
-
161
- ## 📄 License
162
-
163
- FOSSLight Scanner is released under [Apache-2.0][l].
164
-
165
- [l]: https://github.com/fosslight/fosslight_scanner/blob/main/LICENSE
166
-
167
- Platform: UNKNOWN
168
- Classifier: License :: OSI Approved :: Apache Software License
169
- Classifier: Programming Language :: Python :: 3
170
- Classifier: Programming Language :: Python :: 3.8
171
- Classifier: Programming Language :: Python :: 3.9
172
- Classifier: Programming Language :: Python :: 3.10
173
- Classifier: Programming Language :: Python :: 3.11
174
- Requires-Python: >=3.8
175
- Description-Content-Type: text/markdown