Update Help Message

Author: bjk7119

src/fosslight_source/help.py

@@ -0,0 +1,26 @@
+#!/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
+
+_HELP_MESSAGE_SOURCE = """
+    Usage: fosslight_source [option1] <arg1> [option2] <arg2>... 
+
+    FOSSLight Source uses ScanCode, a source code scanner, 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. 
+    And removes words such as “-only” and “-old-style” from the license name to be printed. The output result is generated in Excel format.
+
+    Options:
+        Mandatory
+            -p <source_path>\t\t   Path to analyze source
+        
+        Optional
+            -h\t\t\t\t   Print help message
+            -j\t\t\t\t   Generate additional result of executing ScanCode in json format
+            -o <file_name>\t\t   Output file name"""
+
+
+def print_help_msg():
+    helpMsg = PrintHelpMsg(_HELP_MESSAGE_SOURCE)
+    helpMsg.print_help_msg(True)

src/fosslight_source/run_scancode.py

@@ -19,19 +19,14 @@
 from fosslight_util.timer_thread import TimerThread
 from ._parsing_scancode_file_item import parsing_file_item
 from fosslight_util.write_excel import write_excel_and_csv
+from .help import print_help_msg
 
 logger = logging.getLogger(constant.LOGGER_NAME)
 warnings.filterwarnings("ignore", category=FutureWarning)
 _PKG_NAME = "fosslight_source"
 _ERROR_PREFIX = "* Error : "
 
 
-def print_help_msg():
-    print("* Required : -p path_to_scan")
-    print("* Optional : -j ")
-    sys.exit()
-
-
 def main():
     argv = sys.argv[1:]
     _path_to_scan = ""

tox.ini

@@ -12,6 +12,7 @@ setenv =
   PYTHONPATH=.
 
 commands =
+    fosslight_source -h
     fosslight_source -p test -j -o test_scan/scan_result
     cat test_scan/scan_result.csv
     fosslight_convert -p test_scan/scan_result.json -o test_convert/convert_result