Add function for log item

Author: soimkim

requirements.txt

@@ -2,4 +2,5 @@ XlsxWriter
 pandas
 xlrd
 openpyxl
-progress
+progress
+PyYAML

src/fosslight_util/set_log.py

@@ -6,6 +6,9 @@
 import logging
 import os
 from pathlib import Path
+import pkg_resources
+import sys
+import platform
 from . import constant as constant
 
 
@@ -35,3 +38,20 @@ def init_log(log_file, create_file=True):
         logger.propagate = False
 
     return logger
+
+
+def init_log_item(main_package_name="", path_to_analyze= ""):
+
+    _PYTHON_VERSION = sys.version_info[0]
+    _result_log = {
+        "Tool Info": main_package_name,
+        "Python version": _PYTHON_VERSION,
+        "OS": platform.system()+" "+platform.release(),
+    }
+    if main_package_name != "":
+        pkg_version = pkg_resources.get_distribution(main_package_name).version
+        _result_log["Tool Info"] = main_package_name +" v."+pkg_version
+    if path_to_analyze != "":
+       _result_log["Path to analyze"] = path_to_analyze
+
+    return _result_log

tests/test_log.py

@@ -2,15 +2,20 @@
 # -*- coding: utf-8 -*-
 # Copyright (c) 2021 LG Electronics Inc.
 # SPDX-License-Identifier: Apache-2.0
-
+import yaml
 from fosslight_util.set_log import init_log
+from fosslight_util.set_log import init_log_item
 from _print_log import print_log
 from _print_log_with_another_logger import print_log_another_logger
 
 def main():
     logger = init_log("test_result/log_file1.txt")
     logger.warning("TESTING LOG - from 1st Module")
 
+    result_log = init_log_item("fosslight_util")
+    _str_final_result_log = yaml.safe_dump(result_log, allow_unicode=True)
+    logger.warning(_str_final_result_log)
+
     print_log()
     print_log_another_logger()