fosslight-source 2.2.3__tar.gz → 2.2.4__tar.gz

{fosslight_source-2.2.3/src/fosslight_source.egg-info → fosslight_source-2.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fosslight_source
-Version: 2.2.3
+Version: 2.2.4
 Summary: FOSSLight Source Scanner
 Home-page: https://github.com/fosslight/fosslight_source_scanner
 Download-URL: https://github.com/fosslight/fosslight_source_scanner

{fosslight_source-2.2.3 → fosslight_source-2.2.4}/setup.py

@@ -14,7 +14,7 @@ with open('requirements.txt', 'r', 'utf-8') as f:
 if __name__ == "__main__":
     setup(
         name='fosslight_source',
-        version='2.2.3',
+        version='2.2.4',
         package_dir={"": "src"},
         packages=find_packages(where='src'),
         description='FOSSLight Source Scanner',

fosslight_source-2.2.4/src/fosslight_source/_help.py

@@ -0,0 +1,67 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2021 LG Electronics Inc.
+# SPDX-License-Identifier: Apache-2.0
+from fosslight_util.help import PrintHelpMsg, print_package_version
+from fosslight_util.output_format import SUPPORT_FORMAT
+
+_HELP_MESSAGE_SOURCE_SCANNER = f"""
+    📖 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:
+    print_package_version(pkg_name, "FOSSLight Source Scanner Version:")
+
+
+def print_help_msg_source_scanner() -> None:
+    helpMsg = PrintHelpMsg(_HELP_MESSAGE_SOURCE_SCANNER)
+    helpMsg.print_help_msg(True)

{fosslight_source-2.2.3 → fosslight_source-2.2.4}/src/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-2.2.3 → fosslight_source-2.2.4}/src/fosslight_source/run_scanoss.py

@@ -8,8 +8,8 @@ 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
@@ -19,7 +19,6 @@ import contextlib
 logger = logging.getLogger(constant.LOGGER_NAME)
 warnings.filterwarnings("ignore", category=FutureWarning)
 _PKG_NAME = "fosslight_source"
-SCANOSS_RESULT_FILE = "scanner_output.wfp"
 SCANOSS_OUTPUT_FILE = "scanoss_raw_result.json"
 
 
@@ -27,9 +26,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 +40,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,10 +48,10 @@ 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
+    if os.path.exists(output_json_file):
         os.remove(output_json_file)
 
     try:
@@ -82,6 +81,10 @@ def run_scanoss_py(path_to_scan: str, output_file_name: str = "", format: list =
                 st_python = json.load(st_json)
                 scanoss_file_list = parsing_scan_result(st_python, excluded_files)
 
+        if not write_json_file:
+            if os.path.isfile(output_json_file):
+                os.remove(output_json_file)
+
     except Exception as error:
         logger.debug(f"SCANOSS Parsing {path_to_scan}: {error}")
 

{fosslight_source-2.2.3 → fosslight_source-2.2.4/src/fosslight_source.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fosslight_source
-Version: 2.2.3
+Version: 2.2.4
 Summary: FOSSLight Source Scanner
 Home-page: https://github.com/fosslight/fosslight_source_scanner
 Download-URL: https://github.com/fosslight/fosslight_source_scanner

fosslight_source-2.2.3/src/fosslight_source/_help.py

@@ -1,44 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-# Copyright (c) 2021 LG Electronics Inc.
-# SPDX-License-Identifier: Apache-2.0
-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"""
-
-
-def print_version(pkg_name: str) -> None:
-    print_package_version(pkg_name, "FOSSLight Source Scanner Version:")
-
-
-def print_help_msg_source_scanner() -> None:
-    helpMsg = PrintHelpMsg(_HELP_MESSAGE_SOURCE_SCANNER)
-    helpMsg.print_help_msg(True)