fosslight-source 2.2.3__py3-none-any.whl → 2.2.5__py3-none-any.whl

fosslight_source/_help.py

@@ -6,33 +6,56 @@ from fosslight_util.help import PrintHelpMsg, print_package_version
 from fosslight_util.output_format import SUPPORT_FORMAT
 
 _HELP_MESSAGE_SOURCE_SCANNER = f"""
-    FOSSLight Source Scanner Usage: fosslight_source [option1] <arg1> [option2] <arg2>...
-
-    FOSSLight Source Scanner uses ScanCode and SCANOSS, the source code scanners, to detect
-    the copyright and license phrases contained in the file.
-    Some files (ex- build script), binary files, directory and files in specific
-    directories (ex-test) are excluded from the result.
-
-    Options:
-        Optional
-            -p <source_path>\t   Path to analyze source (Default: current directory)
-            -h\t\t\t   Print help message
-            -v\t\t\t   Print FOSSLight Source Scanner version
-            -m\t\t\t   Print additional information for scan result on separate sheets
-            -e <path>\t\t   Path to exclude from analysis (files and directories)
-            \t\t\t   * IMPORTANT: Always wrap patterns in double quotes ("") to avoid shell expansion.
-            \t\t\t     Example) fosslight_source -e "dev/" "tests/"
-            -o <output_path>\t   Output path (Path or file name)
-            -f <format>\t\t   Output file formats
-            \t\t\t   ({', '.join(SUPPORT_FORMAT)})
-            \t\t\t   Multiple formats can be specified separated by space.
-        Options only for FOSSLight Source Scanner
-            -s <scanner>\t   Select which scanner to be run (scancode, scanoss, kb, all)
-            -j\t\t\t   Generate raw result of scanners in json format
-            -t <float>\t\t   Stop scancode scanning if scanning takes longer than a timeout in seconds.
-            -c <core>\t\t   Select the number of cores to be scanned with ScanCode or threads with SCANOSS.
-            --no_correction\t   Enter if you don't want to correct OSS information with sbom-info.yaml
-            --correct_fpath <path> Path to the sbom-info.yaml file"""
+    📖 Usage
+    ────────────────────────────────────────────────────────────────────
+    fosslight_source [options] <arguments>
+
+    📝 Description
+    ────────────────────────────────────────────────────────────────────
+    FOSSLight Source Scanner analyzes source code to detect copyright and
+    license information using several modes.
+
+    Note: Build scripts, binary files, and test directories are automatically
+          excluded from analysis.
+
+    📚 Guide: https://fosslight.org/fosslight-guide/scanner/2_source.html
+
+    ⚙️  General Options
+    ────────────────────────────────────────────────────────────────────
+    -p <path>              Source path to analyze (default: current directory)
+    -o <path>              Output file path or directory
+    -f <format>            Output formats: {', '.join(SUPPORT_FORMAT)}
+                           (multiple formats can be specified, separated by space)
+    -e <pattern>           Exclude paths from analysis (files and directories)
+                           ⚠️  IMPORTANT: Always wrap in quotes to avoid shell expansion
+                           Example: fosslight_source -e "dev/" "tests/" "*.jar"
+    -m                     Generate detailed scan results on separate sheets
+    -h                     Show this help message
+    -v                     Show version information
+
+    🔍 Scanner-Specific Options
+    ────────────────────────────────────────────────────────────────────
+    -s <mode>              Choose mode: scancode, scanoss, kb, or all(default)
+    -c <number>            Number of CPU cores/threads to use for scanning
+    -t <seconds>           Timeout in seconds for ScanCode scanning
+    -j                     Generate raw scanner results in JSON format
+    --no_correction        Skip OSS information correction with sbom-info.yaml
+    --correct_fpath <path> Path to custom sbom-info.yaml file
+
+    💡 Examples
+    ────────────────────────────────────────────────────────────────────
+    # Scan current directory
+    fosslight_source
+
+    # Scan specific path with exclusions
+    fosslight_source -p /path/to/source -e "test/" "node_modules/"
+
+    # Generate output in specific format
+    fosslight_source -f excel -o results/
+
+    # Generate raw scanner results in JSON format
+    fosslight_source -p /path/to/source -j
+"""
 
 
 def print_version(pkg_name: str) -> None:

fosslight_source/cli.py

@@ -370,7 +370,7 @@ def run_scanners(
     if output_path == "":
         output_path = os.getcwd()
     final_output_path = output_path
-    output_path = os.path.join(os.path.dirname(output_path), '.fosslight_temp')
+    output_path = os.path.join(os.path.dirname(output_path), f'.fosslight_temp_{start_time}')
 
     logger, result_log = init_log(os.path.join(output_path, f"fosslight_log_src_{start_time}.txt"),
                                   True, logging.INFO, logging.DEBUG, PKG_NAME, path_to_scan, path_to_exclude)
@@ -404,8 +404,10 @@ def run_scanners(
                                                                                       excluded_files)
         excluded_files = set(excluded_files) if excluded_files else set()
         if selected_scanner in ['scanoss', 'all']:
-            scanoss_result, api_limit_exceed = run_scanoss_py(path_to_scan, output_file_name, formats, True,
-                                                              num_cores, excluded_path_with_default_exclusion, excluded_files)
+            scanoss_result, api_limit_exceed = run_scanoss_py(path_to_scan, output_path, formats, True, num_cores,
+                                                              excluded_path_with_default_exclusion, excluded_files,
+                                                              write_json_file)
+
         if selected_scanner in SCANNER_TYPE:
             run_kb = True if selected_scanner in ['kb', 'all'] else False
             spdx_downloads, manifest_licenses = metadata_collector(path_to_scan, excluded_files)

fosslight_source/run_scanoss.py

@@ -8,11 +8,12 @@ import importlib_metadata
 import warnings
 import logging
 import json
+from typing import Tuple
 import fosslight_util.constant as constant
-from fosslight_util.output_format import check_output_formats_v2  # , write_output_file
 from ._parsing_scanoss_file import parsing_scan_result  # scanoss
 from ._parsing_scanoss_file import parsing_extra_info  # scanoss
 from scanoss.scanner import Scanner, ScanType
+from scanoss.scanoss_settings import ScanossSettings
 import io
 import contextlib
 
@@ -27,9 +28,10 @@ def get_scanoss_extra_info(scanned_result: dict) -> list:
     return parsing_extra_info(scanned_result)
 
 
-def run_scanoss_py(path_to_scan: str, output_file_name: str = "", format: list = [],
+def run_scanoss_py(path_to_scan: str, output_path: str = "", format: list = [],
                    called_by_cli: bool = False, num_threads: int = -1,
-                   path_to_exclude: list = [], excluded_files: set = None) -> list:
+                   path_to_exclude: list = [], excluded_files: set = None,
+                   write_json_file: bool = False) -> Tuple[list, bool]:
     """
     Run scanoss.py for the given path.
 
@@ -40,7 +42,6 @@ def run_scanoss_py(path_to_scan: str, output_file_name: str = "", format: list =
     :param write_json_file: if requested, keep the raw files.
     :return scanoss_file_list: list of ScanItem (scanned result by files).
     """
-    success, msg, output_path, output_files, output_extensions, formats = check_output_formats_v2(output_file_name, format)
 
     scanoss_file_list = []
     api_limit_exceed = False
@@ -49,19 +50,22 @@ def run_scanoss_py(path_to_scan: str, output_file_name: str = "", format: list =
     except Exception as error:
         logger.warning(f"{error}. Skipping scan with scanoss.")
         logger.warning("Please install scanoss and dataclasses before run fosslight_source with scanoss option.")
-        return scanoss_file_list
+        return scanoss_file_list, api_limit_exceed
 
     output_json_file = os.path.join(output_path, SCANOSS_OUTPUT_FILE)
-    if os.path.exists(output_json_file):  # remove scanner_output.wfp file if exist
+    output_wfp_file = os.path.join(output_path, SCANOSS_RESULT_FILE)
+    if os.path.exists(output_json_file):
         os.remove(output_json_file)
 
     try:
+        scanoss_settings = ScanossSettings()
         scanner = Scanner(
             ignore_cert_errors=True,
             skip_folders=list(path_to_exclude) if path_to_exclude else [],
             scan_output=output_json_file,
             scan_options=ScanType.SCAN_SNIPPETS.value,
-            nb_threads=num_threads if num_threads > 0 else 10
+            nb_threads=num_threads if num_threads > 0 else 10,
+            scanoss_settings=scanoss_settings
         )
 
         output_buffer = io.StringIO()
@@ -81,10 +85,15 @@ def run_scanoss_py(path_to_scan: str, output_file_name: str = "", format: list =
             with open(output_json_file, "r") as st_json:
                 st_python = json.load(st_json)
                 scanoss_file_list = parsing_scan_result(st_python, excluded_files)
-
     except Exception as error:
         logger.debug(f"SCANOSS Parsing {path_to_scan}: {error}")
 
+    if not write_json_file:
+        if os.path.isfile(output_json_file):
+            os.remove(output_json_file)
+        if os.path.isfile(output_wfp_file):
+            os.remove(output_wfp_file)
+
     logger.info(f"|---Number of files detected with SCANOSS: {(len(scanoss_file_list))}")
 
     return scanoss_file_list, api_limit_exceed

{fosslight_source-2.2.3.dist-info → fosslight_source-2.2.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fosslight_source
-Version: 2.2.3
+Version: 2.2.5
 Summary: FOSSLight Source Scanner
 Home-page: https://github.com/fosslight/fosslight_source_scanner
 Download-URL: https://github.com/fosslight/fosslight_source_scanner
@@ -15,7 +15,7 @@ Requires-Python: >=3.10, <3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pyparsing
-Requires-Dist: scanoss>=1.18.0
+Requires-Dist: scanoss>=1.19.0
 Requires-Dist: XlsxWriter
 Requires-Dist: fosslight_util>=2.1.37
 Requires-Dist: PyYAML

{fosslight_source-2.2.3.dist-info → fosslight_source-2.2.5.dist-info}/RECORD

@@ -1,17 +1,17 @@
 fosslight_source/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fosslight_source/_help.py,sha256=Ge6g9GKWGza11E74PFnBMqsj40UCUz-a_xArDZ1FClU,2316
+fosslight_source/_help.py,sha256=Zgc-66WakwuF2iPnoxQlRHx64kLabdiPemkVxKz9S7Y,3553
 fosslight_source/_license_matched.py,sha256=-3H881XQjFDafRttBsuboS3VbCPYEvPH1pwWXptknE4,2164
 fosslight_source/_parsing_scancode_file_item.py,sha256=9TjCwTTPaytqTlZzCKzaX-n20xJLy346xwp0Ee-rWWA,14951
 fosslight_source/_parsing_scanoss_file.py,sha256=L3iHqmQF2jeSpHYuYSre44doXKy-BoX0u1Lm2IfJSU8,3866
 fosslight_source/_scan_item.py,sha256=rWoC-jMc6Hf_dpiwVdQjATNhkzRgLVn966q3UA1TAxc,9412
-fosslight_source/cli.py,sha256=GDwBlwgSvPtWlKhk6hZWQSUl71MJYaGIE4_Mcp1w_L8,20367
+fosslight_source/cli.py,sha256=1Cc1vLESYHzb101OJb9ySgtfNZa0pQRNHxJ1XT1eUrg,20456
 fosslight_source/run_manifest_extractor.py,sha256=8itu69eoriEnSskVDF9rnkLZ3d515KTaKy6tkZKWgBk,8940
 fosslight_source/run_scancode.py,sha256=TFyNLV6P9rSBo9royDoG6az4l7Tkpl8Gr66IFK1DBU8,9021
-fosslight_source/run_scanoss.py,sha256=91hQ60BcjgCkfrcWuMYoR4lRSCa1-AdLMxVubTx_Wv4,3763
+fosslight_source/run_scanoss.py,sha256=Whxcpmsai-Lhlh599PDFAM15ElhPsCtYDM51AOb6V3M,4019
 fosslight_source/run_spdx_extractor.py,sha256=wIdjDIpzglc2tfrh_YodkAQ0QqfgfmJBSuE2bf4w4Tg,862
-fosslight_source-2.2.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-fosslight_source-2.2.3.dist-info/METADATA,sha256=Md1A-4vaFc-sabOYYLntHZFo6NoohWA-Sn_H7K4LWus,3557
-fosslight_source-2.2.3.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
-fosslight_source-2.2.3.dist-info/entry_points.txt,sha256=G4bBRWqSrJ68g-2M-JtNDrSZsdym_M7_KohQ2qR1vG8,113
-fosslight_source-2.2.3.dist-info/top_level.txt,sha256=C2vw-0OIent84Vq-UEk1gt_kK1EL8dIItzBzp3WNyA4,17
-fosslight_source-2.2.3.dist-info/RECORD,,
+fosslight_source-2.2.5.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+fosslight_source-2.2.5.dist-info/METADATA,sha256=1D2bUSE2E2ZRIsYtUzQv_6ebhpo3mLCQXRK1Z69peu4,3557
+fosslight_source-2.2.5.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+fosslight_source-2.2.5.dist-info/entry_points.txt,sha256=G4bBRWqSrJ68g-2M-JtNDrSZsdym_M7_KohQ2qR1vG8,113
+fosslight_source-2.2.5.dist-info/top_level.txt,sha256=C2vw-0OIent84Vq-UEk1gt_kK1EL8dIItzBzp3WNyA4,17
+fosslight_source-2.2.5.dist-info/RECORD,,