Skip to main content

A stylish and colorful Python logging module with customizable console output

Project description

BeamLogger

A stylish and colorful Python logging module with customizable console output.

Features

  • Beautiful colorized log output with different colors for each log level
  • Custom time stamps in 12-hour format
  • Stylish banners with gradient colors using pystyle
  • Custom console window title (Cross-platform - Windows, Linux, macOS)
  • Input prompt with styled formatting
  • Multiple log levels: info, debug, log, success, input, output, error, critical, warn

Requirements

  • colorama
  • pystyle
  • Python 3.6+

Installation

pip install BeamLogger

Usage

from beamlogger import BeamLogger
import platform

# Initialize logger with custom title
system = platform.system()
logger = BeamLogger(f"My Application on {system}")

# Display a banner
banner = """
██████╗ ███████╗ █████╗ ███╗   ███╗██╗      ██████╗  ██████╗  ██████╗ ███████╗██████╗ 
██╔══██╗██╔════╝██╔══██╗████╗ ████║██║     ██╔═══██╗██╔════╝ ██╔════╝ ██╔════╝██╔══██╗
██████╔╝█████╗  ███████║██╔████╔██║██║     ██║   ██║██║  ███╗██║  ███╗█████╗  ██████╔╝
██╔══██╗██╔══╝  ██╔══██║██║╚██╔╝██║██║     ██║   ██║██║   ██║██║   ██║██╔══╝  ██╔══██╗
██████╔╝███████╗██║  ██║██║ ╚═╝ ██║███████╗╚██████╔╝╚██████╔╝╚██████╔╝███████╗██║  ██║
╚═════╝ ╚══════╝╚═╝  ╚═╝╚═╝     ╚═╝╚══════╝ ╚═════╝  ╚═════╝  ╚═════╝ ╚══════╝╚═╝  ╚═╝
"""
logger.banner(banner)

# Different log levels
logger.info("This is an information message")
logger.debug("This is a debug message")
logger.log("This is a regular log message")
logger.success("This is a success message")
logger.warn("This is a warning message")
logger.error("This is an error message")
logger.critical("This is a critical message")

# Get user input
name = logger.input("Please enter your name", "Name")
logger.info(f"Hello, {name}!")

# Change console title
logger.set_title(f"New Title - {name}")

Log Format

The log format follows this pattern:

[Time stamp in 12hrs] ❆ [PREFIX] ➔ Message

For example:

[09:45:32 AM] ❆ [INFO] ➔ This is an information message

Custom Banners

You can create custom banners with different colors:

logger.banner("Your ASCII Art Here", color=pystyle.Colors.purple_to_blue, spacing=10)

Running the Example

To see BeamLogger in action, run the included example:

py example.py

Changelog

v0.1.3

  • Added cross-platform support for console title setting (Windows, Linux, macOS)
  • Fixed console title setting errors on Linux systems
  • Improved error handling for platform-specific features

Crafted With <3 By Bhaskar

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

BeamLogger-0.1.3.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

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

BeamLogger-0.1.3-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file BeamLogger-0.1.3.tar.gz.

File metadata

  • Download URL: BeamLogger-0.1.3.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.6

File hashes

Hashes for BeamLogger-0.1.3.tar.gz
Algorithm Hash digest
SHA256 fb6aea0e85f4b764ea2642fdc81086fd0b52f892b78d765b9d9c819100a0f071
MD5 ed627ad28d6fbb2a7f55a5ce22df473e
BLAKE2b-256 c1429a81fb9d65b5b2e0aecac8e30705caf764c6ab5d11c31675493f5c3b7463

See more details on using hashes here.

File details

Details for the file BeamLogger-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: BeamLogger-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.6

File hashes

Hashes for BeamLogger-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b64a77c8ce05e967d307c6372775b83d743261e32a304c39405690168fbe19c4
MD5 cfa2ba85130593f4b8c8e9be17367901
BLAKE2b-256 31745fff86ef41184f2824e9ba4429e9c17f0b1a1bdead1936bb781fda68be3f

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