Skip to main content

A logging utility for Python. Developed for personal use.

Project description

loggerric

loggerric is a lightweight Python utility library providing advanced logging, for CLI applications. It offers colorful, formatted output to make debugging, logging and tracking easier.


Features

  • Logging: Structured logging with levels: INFO, WARN, ERROR, DEBUG with highlight.
  • Log2File: Fully automatic logging to file, with various options for customization.
  • Pretty Printing: Pretty print variables like arrays and dictionaries.
  • Tables: Log datasets via CLI colored tables with headers and autosizing.
  • Progress Bars: Real-time CLI progress bars with ETA calculations.
  • Prompts: Interactive user input with optional choices and defaults.
  • Timers: Measure execution time of code snippets.
  • Timestamps: Optional, can be used independently, and support rolling differences.

Installation

pip install loggerric

Usage

Log To File

from loggerric import LogToFile, LogToFileLevel

LogToFile.set_dump_location('C:/Users/MyCoolUsername/Desktop', 'important_log') # Don't include the extension

# Control file logging from anywhere
LogToFile.start_logging()
LogToFile.stop_logging()

# Decide what should be logged to file
LogToFile.enable(LogToFileLevel.INFO, ...)
LogToFile.disable(LogToFileLevel.TIMER, ...)

Logging

from loggerric import Log, LogLevel

# Pretty print dictionaries or arrays, including subdicts
Log.pretty_print({ 'name': 'John Doe' }, indent=4)

# Print out a formatted table
headers = ['Item', 'Stock', 'Price']
rows = [('Cola', '25', '$2.99'), ('GPU', '3', '$995.00'), ('Feather', '2,500', '$0.29')]
Log.table(headers, rows, table_name='Store Items')

Log.info("This is an info message", "This is also a message", ..., highlight=['This', 'message'])
Log.warn("This is a warning", ..., highlight='warning')
Log.error("This is an error", ..., quit_after_log=True, highlight='error')
Log.debug("This is a debug message", ..., highlight='debug')

# Enable or disable specific logging levels
Log.disable(LogLevel.DEBUG, LogLevel.WARN, ...)
Log.enable(LogLevel.DEBUG, ...)

Progress Bar

from loggerric import ProgressBar
from time import sleep

end_val = 50
bar = ProgressBar(end_value=end_val, name='Downloading', bar_length=40)
for i in range(1, end_val + 1):
    sleep(0.05)
    bar.update(i)

Prompt

from loggerric import prompt

# Simple input
name = prompt("Enter your name")

# Input with options
choice = prompt("Choose a letter", options=['a', 'b', 'c'], default='b', loop_until_valid=True, case_sensitive=False)

Timer

from loggerric import Timer
from time import sleep

with Timer(name='Calculation Timer'):
    sleep(1.5)

Timestamp

from loggerric import Timestamp, Log

Timestamp.set_format('{HH}:{MM}:{SS}.{MS} T+{dm}ms')

Log.info(Timestamp.get())

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

loggerric-1.4.1.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

loggerric-1.4.1-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file loggerric-1.4.1.tar.gz.

File metadata

  • Download URL: loggerric-1.4.1.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.11

File hashes

Hashes for loggerric-1.4.1.tar.gz
Algorithm Hash digest
SHA256 dce3616b24c39df516d062823f1c9d37ea1c10ccd76d88e027f3a4bf2c0360e4
MD5 c148a359b26df39129ef0246e583fb37
BLAKE2b-256 a391783f2e8e1ab0eedeae3e1f1d22ad984b58e13da00aa9c3aa5933b86abdc0

See more details on using hashes here.

File details

Details for the file loggerric-1.4.1-py3-none-any.whl.

File metadata

  • Download URL: loggerric-1.4.1-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.11

File hashes

Hashes for loggerric-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b0ea74eda5814ee11a11494bccd920af6ed32ee0f052d21ff2997e2a0990e4b5
MD5 fcfec21eee4ea75e3476d221b4abd8bc
BLAKE2b-256 8fc15562c11c1a94e99284cb765f89664da7e7225342506559ba1fe09466373e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page