loggerric 1.0.0__tar.gz

loggerric-1.0.0/LICENSE

@@ -0,0 +1,13 @@
+Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)
+
+Copyright (c) 2025 Luka Jacobsen
+
+You are free to:
+- Share — copy and redistribute the material in any medium or format
+- Adapt — remix, transform, and build upon the material
+
+Under the following terms:
+- Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made.
+- NonCommercial — You may not use the material for commercial purposes.
+
+No additional warranties are provided.

loggerric-1.0.0/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: loggerric
+Version: 1.0.0
+Summary: A fancy logging, progress bar, prompt, and timer utility for Python. Developed for personal use.
+Author: Luka Jacobsen
+License: Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)
+        
+        Copyright (c) 2025 Luka Jacobsen
+        
+        You are free to:
+        - Share — copy and redistribute the material in any medium or format
+        - Adapt — remix, transform, and build upon the material
+        
+        Under the following terms:
+        - Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made.
+        - NonCommercial — You may not use the material for commercial purposes.
+        
+        No additional warranties are provided.
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file

loggerric-1.0.0/loggerric/__init__.py

@@ -0,0 +1,14 @@
+from loggerric._progress_bar import ProgressBar
+from loggerric._log_levels import LogLevel
+from loggerric._prompt import prompt
+from loggerric._timer import Timer
+from loggerric._log import Log
+from colorama import init
+
+# Add option to turn on feedback loop in prompt with options
+
+# Expose these functions/classes
+__all__ = ['LogLevel', 'prompt', 'ProgressBar', 'Log', 'Timer']
+
+# Initialize Colorama
+init(autoreset=True)

loggerric-1.0.0/loggerric/_log.py

@@ -0,0 +1,108 @@
+from colorama import Fore
+from loggerric._log_levels import *
+from loggerric._utils import *
+
+class Log:
+    """
+    **Contains various logging methods.**
+    """
+    # Keep track of what should be logged
+    _active_levels = { LogLevel.INFO, LogLevel.WARN, LogLevel.ERROR, LogLevel.DEBUG }
+
+    @classmethod
+    def info(cls, content:str) -> None:
+        """
+        **Format a message as information.**
+
+        *Parameters*:
+        - `content` (str): The content you want printed.
+
+        *Example*:
+        ```python
+        Log.info(content='Hello World!')
+        ```
+        """
+        # Log the content
+        if LogLevel.INFO in cls._active_levels:
+            print(f'{Fore.MAGENTA}[{timestamp()}] {Fore.GREEN}[i] {content}{Fore.WHITE}')
+
+    @classmethod
+    def warn(cls, content:str) -> None:
+        """
+        **Format a message as a warning.**
+
+        *Parameters*:
+        - `content` (str): The content you want printed.
+
+        *Example*:
+        ```python
+        Log.warn(content='Hello World!')
+        ```
+        """
+        # Log the content
+        if LogLevel.WARN in cls._active_levels:
+            print(f'{Fore.MAGENTA}[{timestamp()}] {Fore.YELLOW}[w] {content}{Fore.WHITE}')
+
+    @classmethod
+    def error(cls, content:str) -> None:
+        """
+        **Format a message as an error.**
+
+        *Parameters*:
+        - `content` (str): The content you want printed.
+
+        *Example*:
+        ```python
+        Log.error(content='Hello World!')
+        ```
+        """
+        # Log the content
+        if LogLevel.ERROR in cls._active_levels:
+            print(f'{Fore.MAGENTA}[{timestamp()}] {Fore.RED}[!] {content}{Fore.WHITE}')
+
+    @classmethod
+    def debug(cls, content:str) -> None:
+        """
+        **Format a message as a debug message.**
+
+        *Parameters*:
+        - `content` (str): The content you want printed.
+
+        *Example*:
+        ```python
+        Log.debug(content='Hello World!')
+        ```
+        """
+        # Log the content
+        if LogLevel.DEBUG in cls._active_levels:
+         print(f'{Fore.MAGENTA}[{timestamp()}] {Fore.LIGHTBLACK_EX}[?] {content}{Fore.WHITE}')
+    
+    @classmethod
+    def enable(cls, *levels:LogLevel) -> None:
+        """
+        **Enable logging methods.**
+
+        *Parameters*:
+        - `*levels` (LogLevel): Levels that should be enabled.
+
+        *Example*:
+        ```python
+        Log.enable(LogLevel.INFO, LogLevel.WARN, ...)
+        ```
+        """
+        cls._active_levels.update(levels)
+    
+    @classmethod
+    def disable(cls, *levels:LogLevel) -> None:
+        """
+        **Disable logging methods.**
+
+        *Parameters*:
+        - `*levels` (LogLevel): Levels that should be disabled.
+
+        *Example*:
+        ```python
+        Log.disable(LogLevel.INFO, LogLevel.WARN, ...)
+        ```
+        """
+        cls._active_levels.difference_update(levels)

loggerric-1.0.0/loggerric/_log_levels.py

@@ -0,0 +1,10 @@
+from enum import Enum, auto
+
+class LogLevel(Enum):
+    """
+    **Enums used for logging.**
+    """
+    INFO = auto()
+    WARN = auto()
+    ERROR = auto()
+    DEBUG = auto()

loggerric-1.0.0/loggerric/_progress_bar.py

@@ -0,0 +1,75 @@
+from time import perf_counter
+from colorama import Fore
+from loggerric._utils import *
+import math
+
+class ProgressBar:
+    """
+    **Push a formatted progressbar to the standard output.**
+
+    *Parameters*:
+    - `end_value` (int): The end iteration number.
+    - `name` (str): The name of the progressbar.
+    - `bar_length` (int): The length of the progressbar.
+
+    *Example*:
+    ```python
+    end_val = 50
+    bar = ProgressBar(end_value=end_val, name='Progress Bar Name', bar_length=50)
+    for i in range(1, end_val + 1):
+        ...
+        bar.update(i)
+    ```
+    """
+    # Dunder: Initialization
+    def __init__(self, end_value:int, name:str='Progress', bar_length:int=50):
+        # Define class scoped variables
+        self.end_value = end_value
+        self.name = name
+        self.bar_length = bar_length
+        self._end_value_digets = len(str(end_value))
+        self.start_time = 0
+        self.elapsed = 0
+
+    # Internal: Method
+    def _format_time(self, seconds:float) -> str:
+        # Convert seconds to hours, minutes and seconds
+        seconds = int(seconds)
+        h, m, s = seconds // 3600, (seconds % 3600) // 60, seconds % 60
+
+        # Format to HH:MM:SS
+        return f'{h:02d}:{m:02d}:{s:02d}'
+
+    # Method
+    def update(self, current_value:int) -> None:
+        """
+        **Called when the progress bar needs to update.**
+
+        *Parameters*:
+        - `current_value` (int): The current value for the progress bar.
+        """
+        # If its the first time called, log the start time
+        if not self.start_time:
+            self.start_time = perf_counter()
+        
+        # String formatted division 'current/end'
+        division = f'{str(current_value).zfill(self._end_value_digets)}/{self.end_value}'
+
+        # Calculate the current progress (scaled to bar length)
+        progress = current_value * self.bar_length / self.end_value
+
+        # String formatted progress bar
+        bar = f'[{Fore.CYAN}{"#" * (math.floor(progress))}{"_" * (self.bar_length - math.floor(progress))}]'
+        
+        # String formatted percentage complete
+        pct = f'{current_value * 100 / self.end_value:.2f}%'
+
+        # Calculate the ETA
+        timer = 'ETA --:--:--'
+        self.elapsed = perf_counter() - self.start_time
+        if current_value > 0:
+            remaining = (self.elapsed / current_value) * (self.end_value - current_value)
+            timer = f'ETA {self._format_time(remaining)}'
+
+        # Log the progress bar
+        print(f'{Fore.MAGENTA}[{timestamp()}] {Fore.BLUE}{self.name}: {Fore.CYAN}{division} {bar} {pct} {timer}{Fore.WHITE}', end='\n' if current_value == self.end_value else '\r')

loggerric-1.0.0/loggerric/_prompt.py

@@ -0,0 +1,42 @@
+from colorama import Fore
+from loggerric._utils import *
+
+def prompt(question:str, options:list[str]=[], default:str=None) -> str | None:
+    """
+    **Prompts standard I/O and returns the answer.**
+
+    If options are given but not chosen by the user during prompting, return value will be `None`
+
+    *Parameters*:
+    - `question` (str): The question appearing in the prompt.
+    - `options` (list[str]): Options that the user can pick from during prompting.
+    - `default` (str): If options are not `None`, optionally specify a default value.
+
+    *Example (No Options)*:
+    ```python
+    answer = prompt(question='Insert your name')
+    ```
+
+    *Example (Options)*:
+    ```python
+    answer = prompt(question="What's the best?", options=['a', 'b', 'c'], default='b')
+    ```
+    """
+    # If no options ommitted prompt immediately
+    if len(options) == 0:
+        return input(f'{Fore.BLUE}{question}: {Fore.CYAN}') or None
+
+    # Format options
+    options_formatted = f'{Fore.BLUE} | '.join(Fore.YELLOW + o for o in options)
+
+    # Prompt user
+    answer = input(f'{Fore.MAGENTA}[{timestamp()}] {Fore.BLUE}{question} [ {options_formatted}{Fore.BLUE} ]{f" ({Fore.YELLOW}{default}{Fore.BLUE})" if default else ""}:{Fore.CYAN} ')
+
+    # Validate answer
+    if len(answer) == 0 and default != None:
+        return default
+    if answer in options:
+        return answer
+    
+    # Implementor decides what to happen if user answers "wrong"
+    return None

loggerric-1.0.0/loggerric/_timer.py

@@ -0,0 +1,44 @@
+from time import perf_counter
+from colorama import Fore
+from loggerric._utils import *
+
+class Timer:
+    """
+    **Time how long a code snippet takes to execute.**
+
+    *Arguments*:
+    - `name` (str): Name of the timer.
+
+    *Example*:
+    ```python
+    with Timer(name='Timer Name'):
+        ...
+    ```
+    """
+    # Dunder: Initialization
+    def __init__(self, name:str='Timer'):        
+        # Define class scoped variables
+        self.name = name
+        self.end_time = 0
+        self.elapsed = 0
+
+    # Dunder: Entering 'with' operator
+    def __enter__(self):
+        # Log the start time in variable, and log to STDIO
+        self.start_time = perf_counter()
+        print(f'{Fore.MAGENTA}[{timestamp()}] {Fore.BLUE}{self.name}: {Fore.CYAN}Started...{Fore.WHITE}')
+
+    # Dunder: Exiting 'with' operator
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        # Log the end time, and calculate the time elapsed
+        self.end_time = perf_counter()
+        self.elapsed = self.end_time - self.start_time
+
+        # Check if duration should be converted to milliseconds
+        is_ms = False
+        if self.elapsed < 1:
+            is_ms = True
+            self.elapsed *= 1_000
+        
+        # Log the duration
+        print(f'{Fore.MAGENTA}[{timestamp()}] {Fore.BLUE}{self.name}: {Fore.CYAN}Finished... {Fore.YELLOW}{self.elapsed:,.5f} {"ms" if is_ms else "s"}{Fore.CYAN} Elapsed.{Fore.WHITE}')

loggerric-1.0.0/loggerric/_utils.py

@@ -0,0 +1,5 @@
+from datetime import datetime
+
+def timestamp() -> str:
+    now = datetime.now()
+    return f'{now.hour:02d}:{now.minute:02d}:{now.second:02d}.{str(now.microsecond)[0:min(3, len(str(now.microsecond)))]}'

loggerric-1.0.0/loggerric.egg-info/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: loggerric
+Version: 1.0.0
+Summary: A fancy logging, progress bar, prompt, and timer utility for Python. Developed for personal use.
+Author: Luka Jacobsen
+License: Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)
+        
+        Copyright (c) 2025 Luka Jacobsen
+        
+        You are free to:
+        - Share — copy and redistribute the material in any medium or format
+        - Adapt — remix, transform, and build upon the material
+        
+        Under the following terms:
+        - Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made.
+        - NonCommercial — You may not use the material for commercial purposes.
+        
+        No additional warranties are provided.
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file

loggerric-1.0.0/loggerric.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+loggerric/__init__.py
+loggerric/_log.py
+loggerric/_log_levels.py
+loggerric/_progress_bar.py
+loggerric/_prompt.py
+loggerric/_timer.py
+loggerric/_utils.py
+loggerric.egg-info/PKG-INFO
+loggerric.egg-info/SOURCES.txt
+loggerric.egg-info/dependency_links.txt
+loggerric.egg-info/top_level.txt

loggerric-1.0.0/loggerric.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

loggerric-1.0.0/loggerric.egg-info/top_level.txt

@@ -0,0 +1 @@
+loggerric

loggerric-1.0.0/pyproject.toml

@@ -0,0 +1,12 @@
+[project]
+name = "loggerric"
+version = "1.0.0"
+description = "A fancy logging, progress bar, prompt, and timer utility for Python. Developed for personal use."
+readme = "README.md"
+requires-python = ">=3.10"
+authors = [{ name="Luka Jacobsen" }]
+license = { file="LICENSE" }
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

loggerric-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+