Add FOSSLight Convert help message

Author: bjk7119

src/fosslight_source/convert_scancode.py

@@ -16,6 +16,7 @@
 import yaml
 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_convert
 
 logger = logging.getLogger(constant.LOGGER_NAME)
 _PKG_NAME = "fosslight_source"
@@ -88,11 +89,6 @@ def get_detected_licenses_from_scancode(scancode_json_file):
     return file_list
 
 
-def print_help_msg():
-    print("* Required :\n -p path_of_scancode_json_result")
-    sys.exit()
-
-
 def main():
     global logger
 
@@ -105,7 +101,7 @@ def main():
         opts, args = getopt.getopt(argv, 'hp:o:')
         for opt, arg in opts:
             if opt == "-h":
-                print_help_msg()
+                print_help_msg_convert()
             elif opt == "-p":
                 path_to_find_bin = arg
             elif opt == "-o":

src/fosslight_source/help.py

@@ -20,7 +20,21 @@
             -j\t\t\t\t   Generate additional result of executing ScanCode in json format
             -o <file_name>\t\t   Output file name"""
 
+_HELP_MESSAGE_CONVERT = """
+    Usage: fosslight_convert [option1] <arg1> [option2] <arg2>... 
 
-def print_help_msg():
+    FOSSLigtht_convert converts the result of executing ScanCode in json format into OSS Report format.
+
+    Options:
+            -h\t\t\t\t   Print help message
+            -p <path_dir>\t\t   Path of ScanCode json files
+            -o <file_name>\t\t   Output file name"""
+
+
+def print_help_msg_source():
     helpMsg = PrintHelpMsg(_HELP_MESSAGE_SOURCE)
+    helpMsg.print_help_msg(True)
+
+def print_help_msg_convert():
+    helpMsg = PrintHelpMsg(_HELP_MESSAGE_CONVERT)
     helpMsg.print_help_msg(True)

src/fosslight_source/run_scancode.py

@@ -19,7 +19,7 @@
 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
+from .help import print_help_msg_source
 
 logger = logging.getLogger(constant.LOGGER_NAME)
 warnings.filterwarnings("ignore", category=FutureWarning)
@@ -37,7 +37,7 @@ def main():
         opts, args = getopt.getopt(argv, 'hjp:o:')
         for opt, arg in opts:
             if opt == "-h":
-                print_help_msg()
+                print_help_msg_source()
             elif opt == "-p":
                 _path_to_scan = arg
             elif opt == "-j":
@@ -46,7 +46,7 @@ def main():
                 _output_file = arg
 
     except Exception:
-        print_help_msg()
+        print_help_msg_source()
 
     timer = TimerThread()
     timer.setDaemon(True)
@@ -83,7 +83,7 @@ def run_scan(path_to_scan, output_file_name="",
         if _windows:
             path_to_scan = os.getcwd()
         else:
-            print_help_msg()
+            print_help_msg_source()
 
     num_cores = multiprocessing.cpu_count() - 1 if num_cores < 0 else num_cores
 

tox.ini

@@ -13,6 +13,7 @@ setenv =
 
 commands =
     fosslight_source -h
+    fosslight_convert -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