fosslight-scanner 2.1.15__py3-none-any.whl → 2.1.17__py3-none-any.whl

fosslight_scanner/_help.py

@@ -6,51 +6,86 @@ from fosslight_util.help import PrintHelpMsg
 from fosslight_util.output_format import SUPPORT_FORMAT
 
 _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.
-
-    Usage: fosslight [Mode] [option1] <arg1> [option2] <arg2>...
-
-    Parameters:
-        Mode: Multiple modes can be entered by separating them with , (ex. source,binary)
-            all\t\t\t    Run all scanners(Default)
-            source\t\t    Run FOSSLight Source Scanner
-            dependency\t\t    Run FOSSLight Dependency Scanner
-            binary\t\t    Run FOSSLight Binary Scanner
-            compare\t\t    Compare two FOSSLight reports
-
-        Options:
-            -h\t\t\t    Print help message
-            -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)
-            -w <link>\t\t    Link to be analyzed can be downloaded by wget or git clone
-            -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 (files and directories)
-                                     * IMPORTANT: Always wrap patterns in double quotes ("") to avoid shell expansion.
-                                       Example) fosslight -e "test/abc.py" "*.jar"
-            -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
-            -t\t\t\t    Hide the progress bar
-            -v\t\t\t    Print FOSSLight Scanner version
-            -s <path>\t            Path to apply setting from file (check format with 'setting.json' in this repository)
-                                     * Direct cli flags have higher priority than setting file
-                                       (ex, '-f yaml -s setting.json' - result file extension is .yaml)
-            --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    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_arg>\t    Additional arguments for running dependency analysis"""
+    📖 Usage
+    ────────────────────────────────────────────────────────────────────
+    fosslight [mode] [options] <arguments>
+
+    📝 Description
+    ────────────────────────────────────────────────────────────────────
+    FOSSLight Scanner performs comprehensive open source analysis by running
+    multiple modes (Source, Dependency, Binary) together. It can download
+    source code from URLs (git/wget) or analyze local paths, and generates
+    results in OSS Report format.
+
+    📚 Guide: https://fosslight.org/fosslight-guide/scanner/
+
+    🔧 Modes
+    ────────────────────────────────────────────────────────────────────
+    all (default)          Run all modes (Source, Dependency, Binary)
+    source                 Run FOSSLight Source analysis only
+    dependency             Run FOSSLight Dependency analysis only
+    binary                 Run FOSSLight Binary analysis only
+    compare                Compare two FOSSLight reports
+
+    Note: Multiple modes can be specified separated by comma
+          Example: fosslight source,binary -p /path/to/analyze
+
+    ⚙️  General Options
+    ────────────────────────────────────────────────────────────────────
+    -p <path>              Path to analyze
+                           • Compare mode: path to two FOSSLight reports (excel/yaml)
+    -w <url>               URL to download and analyze (git clone or wget)
+    -f <format>            Output format ({', '.join(SUPPORT_FORMAT)})
+                           • Compare mode: excel, json, yaml, html
+                           • Multiple formats: ex) -f excel yaml json (separated by space)
+    -e <pattern>           Exclude paths from analysis (files and directories)
+                           ⚠️  IMPORTANT: Always wrap in quotes to avoid shell expansion
+                           Example: fosslight -e "test/" "*.jar"
+    -o <path>              Output directory or file name
+    -c <number>            Number of processes for source analysis
+    -r                     Keep raw data from scanners
+    -t                     Hide progress bar
+    -h                     Show this help message
+    -v                     Show version information
+    -s <path>              Apply settings from JSON file(check format with 'setting.json' in this repository)
+                           Note: CLI flags override settings file
+                           Example: -f yaml -s setting.json → output is .yaml
+    --no_correction        Skip OSS information correction with sbom-info.yaml
+    --correct_fpath <path> Path to sbom-info.yaml file for correction
+    --recursive_dep        Recursively analyze dependencies
+
+    🔍 Mode-Specific Options
+    ────────────────────────────────────────────────────────────────────
+    For 'all' or 'binary' mode:
+      -u <db_url>          Database connection string
+                           Format: postgresql://username:password@host:port/database
+
+    For 'all' or 'dependency' mode:
+      -d <args>            Additional arguments for dependency analysis
+
+    💡 Examples
+    ────────────────────────────────────────────────────────────────────
+    # Scan current directory with all scanners
+    fosslight
+
+    # Scan specific path with exclusions
+    fosslight -p /path/to/source -e "test/" "node_modules/" "*.pyc"
+
+    # Generate output in specific format
+    fosslight -p /path/to/source -f yaml
+
+    # Run specific modes only
+    fosslight source,dependency -p /path/to/source
+
+    # Download and analyze from git repository
+    fosslight -w https://github.com/user/repo.git -o result_dir
+
+    # Compare two FOSSLight reports
+    fosslight compare -p report_v1.xlsx report_v2.xlsx -f excel
+
+    # Run with database connection for binary analysis
+    fosslight binary -p /path/to/binary -u "postgresql://user:pass@localhost:5432/sample"
+    """
 
 
 def print_help_msg():

{fosslight_scanner-2.1.15.dist-info → fosslight_scanner-2.1.17.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fosslight_scanner
-Version: 2.1.15
+Version: 2.1.17
 Summary: FOSSLight Scanner
 Home-page: https://github.com/fosslight/fosslight_scanner
 Download-URL: https://github.com/fosslight/fosslight_scanner

{fosslight_scanner-2.1.15.dist-info → fosslight_scanner-2.1.17.dist-info}/RECORD

@@ -1,15 +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=sWJ5wapLWLGDv2Acm9Eh4i3dTxdrYiLB2T7BPYC2os0,3366
+fosslight_scanner/_help.py,sha256=XksjW1Q4t61vlRzoPfrcjt0-VHz2K8vrkOgPA7hsOqk,5009
 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=5FncXIl2sMNOQWkbAOsfyF1907z571SDnYUvuifR-fM,23172
 fosslight_scanner/resources/bom_compare.html,sha256=VocJ9bDmQQOwfGyvXatPZ4W-QddO-IlsAvKdO0nZ7pA,2240
-fosslight_scanner-2.1.15.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-fosslight_scanner-2.1.15.dist-info/METADATA,sha256=1NeNyB5v5nLJRblg0j1UJBVkk3XYHriNGxTh_joEWc8,8777
-fosslight_scanner-2.1.15.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
-fosslight_scanner-2.1.15.dist-info/entry_points.txt,sha256=dl7AA0_Jqnq0NHuCEaxcJFgstLw3sod_-FGtcgZuJbs,104
-fosslight_scanner-2.1.15.dist-info/top_level.txt,sha256=43_xLb5KYpy8wOU1H2Wd2fEsWBY7Dg6ZEJJXkfT64Ak,18
-fosslight_scanner-2.1.15.dist-info/RECORD,,
+fosslight_scanner-2.1.17.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+fosslight_scanner-2.1.17.dist-info/METADATA,sha256=2C09mzH_gD5op7thhJ2k8MXnV7A05N5iM3evaR7gEA0,8777
+fosslight_scanner-2.1.17.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+fosslight_scanner-2.1.17.dist-info/entry_points.txt,sha256=dl7AA0_Jqnq0NHuCEaxcJFgstLw3sod_-FGtcgZuJbs,104
+fosslight_scanner-2.1.17.dist-info/top_level.txt,sha256=43_xLb5KYpy8wOU1H2Wd2fEsWBY7Dg6ZEJJXkfT64Ak,18
+fosslight_scanner-2.1.17.dist-info/RECORD,,