fosslight-scanner 2.1.9__py3-none-any.whl → 2.1.11__py3-none-any.whl

fosslight_scanner/_help.py

@@ -3,8 +3,9 @@
 # Copyright (c) 2021 LG Electronics Inc.
 # SPDX-License-Identifier: Apache-2.0
 from fosslight_util.help import PrintHelpMsg
+from fosslight_util.output_format import SUPPORT_FORMAT
 
-_HELP_MESSAGE_SCANNER = """
+_HELP_MESSAGE_SCANNER = f"""
     FOSSLight Scanner performs open source analysis after downloading the source from URL that can be cloned by git or wget.
     Instead, open source analysis and checking copyright/license rules can be performed for the local source path.
     The output result is generated in OSS Report format.
@@ -21,14 +22,14 @@ _HELP_MESSAGE_SCANNER = """
 
         Options:
             -h\t\t\t    Print help message
-            -p <path>\t\t    Path to analyze (ex, -p {input_path})
+            -p <path>\t\t    Path to analyze (ex, -p [input_path])
                                      * Compare mode input file: Two FOSSLight reports (supports excel, yaml)
-                                       (ex, -p {before_name}.xlsx {after_name}.xlsx)
+                                       (ex, -p [before_name].xlsx [after_name].xlsx)
             -w <link>\t\t    Link to be analyzed can be downloaded by wget or git clone
-            -f <formats> [<format> ...]\t    FOSSLight Report file format (excel, csv, opossum, yaml, spdx-tag, spdx-yaml, spdx-json, spdx-xml)
+            -f <formats> [<format> ...]\t    FOSSLight Report file format ({', '.join(SUPPORT_FORMAT)})
                                      * Compare mode result file: supports excel, json, yaml, html
                                      * Multiple formats can be specified separated by space.
-            -e <path>\t\t    Path to exclude from analysis (ex, -e {dir} {file})
+            -e <path>\t\t    Path to exclude from analysis (ex, -e [dir] [file])
             -o <output>\t\t    Output directory or file
             -c <number>\t\t    Number of processes to analyze source
             -r\t\t\t    Keep raw data
@@ -40,13 +41,14 @@ _HELP_MESSAGE_SCANNER = """
             --no_correction\t    Enter if you don't want to correct OSS information with sbom-info.yaml
                                      * Correction mode only supported xlsx format.
             --correct_fpath <path>  Path to the sbom-info.yaml file
-            --ui\t\t\t  Generate UI mode result file
+            --ui\t\t    Generate UI mode result file
+            --recursive_dep\t    Recursively analyze dependencies
 
         Options for only 'all' or 'bin' mode
             -u <db_url>\t\t    DB Connection(format :'postgresql://username:password@host:port/database_name')
 
         Options for only 'all' or 'dependency' mode
-            -d <dependency_argument>\t    Additional arguments for running dependency analysis"""
+            -d <dependency_arg>\t    Additional arguments for running dependency analysis"""
 
 
 def print_help_msg():

fosslight_scanner/_parse_setting.py

@@ -25,12 +25,13 @@ def parse_setting_json(data):
     source_print_matched_text = data.get('source_print_matched_text', False)
     source_time_out = data.get('source_time_out', 120)
     binary_simple = data.get('binary_simple', False)
+    recursive_dep = data.get('recursive_dep', False)
     str_lists = [mode, path, exclude_path]
     strings = [
         dep_argument, output, format, db_url,
         correct_fpath, link, selected_source_scanner
     ]
-    booleans = [timer, raw, no_correction, ui, source_write_json_file, source_print_matched_text, binary_simple]
+    booleans = [timer, raw, no_correction, ui, source_write_json_file, source_print_matched_text, binary_simple, recursive_dep]
 
     is_incorrect = False
 
@@ -65,4 +66,4 @@ def parse_setting_json(data):
     return mode, path, dep_argument, output, format, link, db_url, timer, \
         raw, core, no_correction, correct_fpath, ui, exclude_path, \
         selected_source_scanner, source_write_json_file, source_print_matched_text, source_time_out, \
-        binary_simple
+        binary_simple, recursive_dep

fosslight_scanner/cli.py

@@ -15,7 +15,8 @@ from fosslight_util.help import print_package_version
 
 
 def set_args(mode, path, dep_argument, output, format, link, db_url, timer,
-             raw, core, no_correction, correct_fpath, ui, setting, exclude_path):
+             raw, core, no_correction, correct_fpath, ui, setting, exclude_path,
+             recursive_dep):
 
     selected_source_scanner = "all"
     source_write_json_file = False
@@ -30,7 +31,7 @@ def set_args(mode, path, dep_argument, output, format, link, db_url, timer,
             s_mode, s_path, s_dep_argument, s_output, s_format, s_link, s_db_url, s_timer, s_raw, s_core, \
                 s_no_correction, s_correct_fpath, s_ui, s_exclude_path, \
                 s_selected_source_scanner, s_source_write_json_file, s_source_print_matched_text, \
-                s_source_time_out, s_binary_simple = parse_setting_json(data)
+                s_source_time_out, s_binary_simple, s_recursive_dep = parse_setting_json(data)
 
             # direct cli arguments have higher priority than setting file
             mode = mode or s_mode
@@ -47,6 +48,7 @@ def set_args(mode, path, dep_argument, output, format, link, db_url, timer,
             correct_fpath = correct_fpath or s_correct_fpath
             ui = ui or s_ui
             exclude_path = exclude_path or s_exclude_path
+            recursive_dep = recursive_dep or s_recursive_dep
 
             # These options are only set from the setting file, not from CLI arguments
             selected_source_scanner = s_selected_source_scanner or selected_source_scanner
@@ -60,7 +62,7 @@ def set_args(mode, path, dep_argument, output, format, link, db_url, timer,
     return mode, path, dep_argument, output, format, link, db_url, timer, \
         raw, core, no_correction, correct_fpath, ui, exclude_path, \
         selected_source_scanner, source_write_json_file, source_print_matched_text, source_time_out, \
-        binary_simple
+        binary_simple, recursive_dep
 
 
 def main():
@@ -79,7 +81,7 @@ def main():
                         type=str, dest='format',nargs='*', default=[])
     parser.add_argument('--output', '-o', help='Output directory or file',
                         type=str, dest='output', default="")
-    parser.add_argument('--dependency', '-d', help='Dependency arguments',
+    parser.add_argument('--dependency', '-d', help='Dependency arguments (e.g. -d "-m pip" )',
                         type=str, dest='dep_argument', default="")
     parser.add_argument('--url', '-u', help="DB Url",
                         type=str, dest='db_url', default="")
@@ -105,6 +107,8 @@ def main():
                         type=str, required=False, default='')
     parser.add_argument('--ui', help='Generate UI mode result file',
                         action='store_true', required=False, default=False)
+    parser.add_argument('--recursive_dep', '-rd', help='Recursively analyze dependencies',
+                        action='store_true', dest='recursive_dep', default=False)
 
     try:
         args = parser.parse_args()
@@ -118,16 +122,16 @@ def main():
     else:
         mode, path, dep_argument, output, format, link, db_url, timer, raw, core, no_correction, correct_fpath, \
             ui, exclude_path, selected_source_scanner, source_write_json_file, source_print_matched_text, \
-            source_time_out, binary_simple, = set_args(
+            source_time_out, binary_simple, recursive_dep = set_args(
                 args.mode, args.path, args.dep_argument, args.output,
                 args.format, args.link, args.db_url, args.timer, args.raw,
                 args.core, args.no_correction, args.correct_fpath, args.ui,
-                args.setting, args.exclude_path)
+                args.setting, args.exclude_path, args.recursive_dep)
 
         run_main(mode, path, dep_argument, output, format, link, db_url, timer,
                  raw, core, not no_correction, correct_fpath, ui, exclude_path,
                  selected_source_scanner, source_write_json_file, source_print_matched_text,
-                 source_time_out, binary_simple)
+                 source_time_out, binary_simple, recursive_dep)
 
 
 if __name__ == "__main__":

fosslight_scanner/fosslight_scanner.py

@@ -57,7 +57,8 @@ SCANNER_MODE = [
 ]
 
 
-def run_dependency(path_to_analyze, output_file_with_path, params="", path_to_exclude=[], formats=[]):
+def run_dependency(path_to_analyze, output_file_with_path, params="", path_to_exclude=[], formats=[],
+                   recursive_dep=False):
     result = []
 
     package_manager = ""
@@ -100,7 +101,9 @@ def run_dependency(path_to_analyze, output_file_with_path, params="", path_to_ex
             output_file_with_path,
             pip_activate_cmd, pip_deactivate_cmd,
             output_custom_dir, app_name,
-            github_token, formats, True, path_to_exclude=path_to_exclude
+            github_token, formats, True, path_to_exclude=path_to_exclude,
+            graph_path="", graph_size=(600,600),
+            recursive=recursive_dep
         )
         if success:
             result = scan_item
@@ -131,7 +134,7 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
                 default_oss_name="", default_oss_version="", url="",
                 correct_mode=True, correct_fpath="", ui_mode=False, path_to_exclude=[],
                 selected_source_scanner="all", source_write_json_file=False, source_print_matched_text=False,
-                source_time_out=120, binary_simple=False, formats=[]):
+                source_time_out=120, binary_simple=False, formats=[], recursive_dep=False):
     final_excel_dir = output_path
     success = True
     all_cover_items = []
@@ -232,7 +235,8 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
 
             if run_dep:
                 dep_scanitem = run_dependency(src_path, _output_dir,
-                                              dep_arguments, path_to_exclude, formats)
+                                              dep_arguments, path_to_exclude, formats,
+                                              recursive_dep)
                 all_scan_item.file_items.update(dep_scanitem.file_items)
                 all_cover_items.append(dep_scanitem.cover)
         else:
@@ -359,7 +363,7 @@ def run_main(mode_list, path_arg, dep_arguments, output_file_or_dir, file_format
              db_url, hide_progressbar=False, keep_raw_data=False, num_cores=-1,
              correct_mode=True, correct_fpath="", ui_mode=False, path_to_exclude=[],
              selected_source_scanner="all", source_write_json_file=False, source_print_matched_text=False,
-             source_time_out=120, binary_simple=False):
+             source_time_out=120, binary_simple=False, recursive_dep=False):
     global _executed_path, _start_time
 
     output_files = []
@@ -470,7 +474,7 @@ def run_main(mode_list, path_arg, dep_arguments, output_file_or_dir, file_format
                                 default_oss_name, default_oss_version, url_to_analyze,
                                 correct_mode, correct_fpath, ui_mode, path_to_exclude,
                                 selected_source_scanner, source_write_json_file, source_print_matched_text, source_time_out,
-                                binary_simple, formats)
+                                binary_simple, formats, recursive_dep)
 
                 if extract_folder:
                     shutil.rmtree(extract_folder)

{fosslight_scanner-2.1.9.dist-info → fosslight_scanner-2.1.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
-Name: fosslight-scanner
-Version: 2.1.9
+Metadata-Version: 2.4
+Name: fosslight_scanner
+Version: 2.1.11
 Summary: FOSSLight Scanner
 Home-page: https://github.com/fosslight/fosslight_scanner
 Download-URL: https://github.com/fosslight/fosslight_scanner
@@ -20,11 +20,22 @@ Requires-Dist: openpyxl
 Requires-Dist: progress
 Requires-Dist: pyyaml
 Requires-Dist: beautifulsoup4
-Requires-Dist: fosslight-util<3.0.0,>=2.1.12
-Requires-Dist: fosslight-source<3.0.0,>=2.1.12
-Requires-Dist: fosslight-dependency<5.0.0,>=4.1.3
-Requires-Dist: fosslight-binary<6.0.0,>=5.1.9
-Requires-Dist: fosslight-prechecker<5.0.0,>=4.0.0
+Requires-Dist: fosslight_util<3.0.0,>=2.1.12
+Requires-Dist: fosslight_source<3.0.0,>=2.1.12
+Requires-Dist: fosslight_dependency<5.0.0,>=4.1.3
+Requires-Dist: fosslight_binary<6.0.0,>=5.1.9
+Requires-Dist: fosslight_prechecker<5.0.0,>=4.0.0
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 <!--
 Copyright (c) 2021 LG Electronics

fosslight_scanner-2.1.11.dist-info/RECORD

@@ -0,0 +1,15 @@
+fosslight_scanner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fosslight_scanner/_get_input.py,sha256=f78M57QU7Lhw1VfZJKvYXbGsUiYMViPz1---UDIbV9I,1396
+fosslight_scanner/_help.py,sha256=5G_oL80402ylacXLnPDGn4xmJKsmv_FL_RBgLjdQ_Hw,3162
+fosslight_scanner/_parse_setting.py,sha256=htxNNvhizZ2ZT18Aw6ihKuBpOMAyptkbMS5Z0_Xh5mQ,2551
+fosslight_scanner/_run_compare.py,sha256=zmzX-FIvWCSkwPvEA3iHfVpyg6QDGUCpw3tJuGLdPWM,10657
+fosslight_scanner/cli.py,sha256=vz_oGevbejqo3tHa4z6d-Ft0xu-gP9Pg-VmXb9IhO_s,6910
+fosslight_scanner/common.py,sha256=FyEoqVsIZ4pRIlHRXZES8PYaYfy3PEmUaOn02YSuuYU,8377
+fosslight_scanner/fosslight_scanner.py,sha256=wOSSnJZuUCvom9rvdwOUy7B2f-CUzDdecI2hm52dyFg,21174
+fosslight_scanner/resources/bom_compare.html,sha256=VocJ9bDmQQOwfGyvXatPZ4W-QddO-IlsAvKdO0nZ7pA,2240
+fosslight_scanner-2.1.11.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+fosslight_scanner-2.1.11.dist-info/METADATA,sha256=ax8sP05BErlpivlIdBQqdaYEGL3f7Ga7HC53K_EkGgY,8059
+fosslight_scanner-2.1.11.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+fosslight_scanner-2.1.11.dist-info/entry_points.txt,sha256=dl7AA0_Jqnq0NHuCEaxcJFgstLw3sod_-FGtcgZuJbs,104
+fosslight_scanner-2.1.11.dist-info/top_level.txt,sha256=43_xLb5KYpy8wOU1H2Wd2fEsWBY7Dg6ZEJJXkfT64Ak,18
+fosslight_scanner-2.1.11.dist-info/RECORD,,

{fosslight_scanner-2.1.9.dist-info → fosslight_scanner-2.1.11.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.45.1)
+Generator: setuptools (79.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

fosslight_scanner-2.1.9.dist-info/RECORD

@@ -1,15 +0,0 @@
-fosslight_scanner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fosslight_scanner/_get_input.py,sha256=f78M57QU7Lhw1VfZJKvYXbGsUiYMViPz1---UDIbV9I,1396
-fosslight_scanner/_help.py,sha256=-Dqgn1inH26614GjrIe8I5cdEziuAxTtwrUdtTkrpjQ,3084
-fosslight_scanner/_parse_setting.py,sha256=SoIEoPGlFXAp6__eEFEMIPYPoKLvmqxXF5X_C_uFiVI,2468
-fosslight_scanner/_run_compare.py,sha256=zmzX-FIvWCSkwPvEA3iHfVpyg6QDGUCpw3tJuGLdPWM,10657
-fosslight_scanner/cli.py,sha256=C4YNPVJJ-Ezj_6xe8k9QbIrf5V44GXbHWCGzR2FMcV8,6547
-fosslight_scanner/common.py,sha256=FyEoqVsIZ4pRIlHRXZES8PYaYfy3PEmUaOn02YSuuYU,8377
-fosslight_scanner/fosslight_scanner.py,sha256=TLMzzXjjPFAzrdS50ruqADKF8Shkf429O2BQeinkxPM,20930
-fosslight_scanner/resources/bom_compare.html,sha256=VocJ9bDmQQOwfGyvXatPZ4W-QddO-IlsAvKdO0nZ7pA,2240
-fosslight_scanner-2.1.9.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-fosslight_scanner-2.1.9.dist-info/METADATA,sha256=y1f4kwBG6-smcAnnPVzKL_fAktgLYh_XwRftcFvBMMw,7822
-fosslight_scanner-2.1.9.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-fosslight_scanner-2.1.9.dist-info/entry_points.txt,sha256=dl7AA0_Jqnq0NHuCEaxcJFgstLw3sod_-FGtcgZuJbs,104
-fosslight_scanner-2.1.9.dist-info/top_level.txt,sha256=43_xLb5KYpy8wOU1H2Wd2fEsWBY7Dg6ZEJJXkfT64Ak,18
-fosslight_scanner-2.1.9.dist-info/RECORD,,