Merge pull request #4 from fosslight/develop

Add a class for printing spinner

Author: soimkim

README.md

@@ -9,6 +9,7 @@ It is a package that supports common utils used by FOSSLight Scanner.
 2. It easily outputs csv file and excel file in OSS Report format.
 3. It provides a simple function to create a text file.
 4. It defines common constant variables.
+5. It provides a thread that prints the spinner.
 
 [or]: http://collab.lge.com/main/x/xDHlFg
 
@@ -84,6 +85,16 @@ logger = logging.getLogger(constant.LOGGER_NAME)
 logger.warning("Get a logger after init_log is called once.")
 ```
 
+### 5. Call a spinner (tests/test_timer.py)
+```
+from fosslight_util.timer_thread import TimerThread
+
+
+timer = TimerThread()
+timer.setDaemon(True)
+timer.start()
+```
+
 ## 👏 How to report issue
 
 Please report any ideas or bugs to improve by creating an issue in [fosslight_util repository][cl]. Then there will be quick bug fixes and upgrades. Ideas to improve are always welcome.

requirements.txt

@@ -1,4 +1,6 @@
 XlsxWriter
 pandas
 xlrd
-openpyxl
+openpyxl
+progress
+PyYAML

setup.py

@@ -13,7 +13,7 @@
 if __name__ == "__main__":
     setup(
         name='fosslight_util',
-        version='1.0.2',
+        version='1.0.3',
         package_dir={"": "src"},
         packages=find_packages(where='src'),
         description='FOSSLight Util',

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

src/fosslight_util/timer_thread.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2021 LG Electronics Inc.
+# SPDX-License-Identifier: Apache-2.0
+import threading
+import time
+from progress.spinner import Spinner
+
+class TimerThread(threading.Thread):
+    def __init__(self):
+        threading.Thread.__init__(self, name=' Thread')
+
+    def run(self):
+        spinner = Spinner('')
+        while True:
+            time.sleep(1)
+            spinner.next()

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()
 

tests/test_timer.py

@@ -0,0 +1,19 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2021 LG Electronics Inc.
+# SPDX-License-Identifier: Apache-2.0
+import os
+import time
+from fosslight_util.timer_thread import TimerThread
+
+
+def main():
+    timer = TimerThread()
+    timer.setDaemon(True)
+    timer.start()
+
+    time.sleep(3)
+
+
+if __name__ == '__main__':
+    main()

tox.ini

@@ -24,3 +24,5 @@ commands =
     python tests/test_excel.py
     ls test_result/excel
     cat test_result/excel/OSS-Report.csv
+    # Test - timer
+    python tests/test_timer.py