simplecolorlogger 0.1__py3-none-any.whl

simplecolorlogger/__init__.py

@@ -0,0 +1 @@
+from .main import Logger

simplecolorlogger/main.py

@@ -0,0 +1,135 @@
+from colorama import Fore, Style, just_fix_windows_console
+from time import gmtime, strftime
+from datetime import datetime
+from os import path, remove, makedirs
+import sys
+
+class Logger():
+    """
+    A simple to use logger that provides colored log messages.
+    logging_level: int -> [0: Disabled, 1: INFO, 2: WARNING, 3: CRITICAL, 4: ERROR, 5: DEBUG]
+    Used to set the maximum logging level to be used.
+        default = 0
+    file_logging: bool -> Enable/Disable writing log file 
+        default = False
+    log_save_location: str -> A relative path to the location where logs are save
+        default = "./logs"
+    log_save_name: str -> The generic name for the written log files 
+        default = "log"
+    log_time_stamping: bool -> Enable/Disable appending a datestamp to log files 
+        default = True
+    msg_time_stamping: bool -> Enable/Disable prepending a timestamp to log messages
+        default = True
+    """
+     
+    _logging_level: int = 0
+    _file_logging: bool = False
+    _log_save_location: str = "./logs"
+    _log_save_name: str = "log"
+    _log_date_stamping: bool = True
+    _msg_time_stamping: bool = True
+
+    _lb: str = f"{Style.BRIGHT}{Fore.LIGHTCYAN_EX}[{Style.RESET_ALL}"
+    _rb: str = f"{Style.BRIGHT}{Fore.LIGHTCYAN_EX}]{Style.RESET_ALL}"
+    _col: str = f"{Style.BRIGHT}{Fore.LIGHTCYAN_EX} : {Style.RESET_ALL}"
+    _bar: str = f"{Style.BRIGHT}{Fore.LIGHTCYAN_EX} | {Style.RESET_ALL}"
+    _arw: str = f"{Style.BRIGHT}{Fore.LIGHTCYAN_EX} -> {Style.RESET_ALL}"
+    _lv1: str = f"{_lb}{Style.BRIGHT}{Fore.LIGHTBLUE_EX}INFO{Style.RESET_ALL}{_rb}{_bar}"
+    _lv2: str = f"{_lb}{Style.BRIGHT}{Fore.LIGHTRED_EX}WARNING{Style.RESET_ALL}{_rb}{_bar}"
+    _lv3: str = f"{_lb}{Style.BRIGHT}{Fore.LIGHTYELLOW_EX}CRITICAL{Style.RESET_ALL}{_rb}{_bar}"
+    _lv4: str = f"{_lb}{Style.BRIGHT}{Fore.RED}ERROR{Style.RESET_ALL}{_rb}{_bar}"
+    _lv5: str = f"{_lb}{Style.BRIGHT}{Fore.MAGENTA}DEBUG{Style.RESET_ALL}{_rb}{_bar}"
+
+    def __init__(self, logging_level: int, file_logging: bool = False, msg_time_stamping: bool = True, log_date_stamping: bool = True, log_save_location: str = "", log_save_name: str = "") -> None:
+        self._logging_level = logging_level
+        self._file_logging = file_logging
+        self._log_date_stamping = log_date_stamping
+        self._msg_time_stamping = msg_time_stamping
+        if not log_save_location == "": self._log_save_location = log_save_location
+        if not log_save_name == "": self._log_save_name = log_save_name
+        just_fix_windows_console()
+
+    def update_logging_level(self, logging_level: int) -> None:
+        """
+        Update the current maximum logging level
+        """
+        self._logging_level = logging_level
+
+    def update_file_logging(self, file_logging: bool) -> None:
+        """
+        Update whether to save a log file
+        """
+        self._file_logging = file_logging
+
+    def update_log_date_stamping(self, log_date_stamping: bool) -> None:
+        """
+        Update whether to append a datestamp to log files 
+        """
+        self._log_date_stamping = log_date_stamping
+
+    def update_msg_time_stamping(self, msg_time_stamping: bool) -> None:
+        """
+        Update whether to prepend a timestamp to logged message
+        """
+        self._msg_time_stamping = msg_time_stamping
+
+    def update_log_save_location(self, log_save_location: str) -> None:
+        """
+        Update the relative path of the log file save location
+        """
+        self._log_save_location = log_save_location
+
+    def update_log_save_name(self, log_save_name: str) -> None:
+        """
+        Update the log's generic name
+        """
+        self._log_save_name = log_save_name
+
+    def log_message(self, text: str, level: int = 0, class_name: str = "Logger", method_name: str = "log_message") -> None:
+        """
+        Used to both print and write a log message to the console and a file.
+        text: str -> The raw text to log 
+            No Default
+        level: int -> The log level of the message. 0 in this context uses the Logger's current maxium
+            default: 0
+        class_name: str -> The name of the class the log is being sent from
+            default: "Logger"
+        method_name: str -> The name of the method the log is being sent from
+            default: "log_message"
+        """
+        if level == 0: level = self._logging_level
+        if level <= self._logging_level and not self._logging_level == 0:
+            _msg_stamp = ""
+            _base = f"{self._lb}{Style.BRIGHT}{Fore.LIGHTGREEN_EX}{class_name}{Style.RESET_ALL}{self._col}{Style.BRIGHT}{Fore.LIGHTWHITE_EX}{method_name}{Style.RESET_ALL}{self._rb}{self._arw}{text}"
+            if self._msg_time_stamping: _msg_stamp = f"{datetime.now().strftime("[%I:%M:%S] :: ")}"
+            match level:
+                case 1:
+                    sys.stdout.write(f"{_msg_stamp}{self._lv1}{_base}\n")
+                case 2:
+                    sys.stdout.write(f"{_msg_stamp}{self._lv2}{_base}\n")
+                case 3:
+                    sys.stdout.write(f"{_msg_stamp}{self._lv3}{_base}\n")
+                case 4:
+                    sys.stdout.write(f"{_msg_stamp}{self._lv4}{_base}\n")
+                case 5:
+                    sys.stdout.write(f"{_msg_stamp}{self._lv5}{_base}\n")
+            if self._file_logging:
+                _file_stamp = "" 
+                if self._log_date_stamping: _file_stamp = f"-{strftime("%Y-%m-%d", gmtime())}"
+                if path.exists(f"{self._log_save_location}/"):
+                    if path.exists(f"{self._log_save_location}/{self._log_save_location}{_file_stamp}"): 
+                        remove(f"{self._log_save_location}/{self._log_save_location}{_file_stamp}")
+                else:
+                    makedirs(f"{self._log_save_location}/")
+                with open(f"{self._log_save_location}/{self._log_save_name}{_file_stamp}", "a") as log_file:
+                    match level:
+                        case 1:
+                                log_file.write(f"{_msg_stamp}[INFO] | [{class_name} : {method_name}] -> {text}\n")
+                        case 2:
+                                log_file.write(f"{_msg_stamp}[WARNING] | [{class_name} : {method_name}] -> {text}\n")
+                        case 3:
+                                log_file.write(f"{_msg_stamp}[CRITICAL] | [{class_name} : {method_name}] -> {text}\n")
+                        case 4:
+                                log_file.write(f"{_msg_stamp}[ERROR] | [{class_name} : {method_name}] -> {text}\n")
+                        case 5:
+                                log_file.write(f"{_msg_stamp}[DEBUG] | [{class_name} : {method_name}] -> {text}\n")

simplecolorlogger-0.1.dist-info/METADATA

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: simplecolorlogger
+Version: 0.1
+Requires-Dist: colorama>=0.4.6
+Dynamic: requires-dist

simplecolorlogger-0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+simplecolorlogger/__init__.py,sha256=WJrLj_ooNmEFjNR4BG2DnjtLZrvGG2TjLzQ6wAE6eIw,25
+simplecolorlogger/main.py,sha256=ovyx-BVOhj1zmy7SQCpEfEueTF1WfchUAJ1H5P--wh8,6696
+simplecolorlogger-0.1.dist-info/METADATA,sha256=1DHPDe85jFZ73OZ4Nc4ROCcXnzpJT0oxnJjZaFfMFwM,113
+simplecolorlogger-0.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+simplecolorlogger-0.1.dist-info/top_level.txt,sha256=9c-rTYuoS4O2zYQtbyn_G8a3-oftW_9BaUoEvN2lcYA,18
+simplecolorlogger-0.1.dist-info/RECORD,,

simplecolorlogger-0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

simplecolorlogger-0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+simplecolorlogger