Skip to content

Repository files navigation

🌈 Colored Custom Logger

PyPI version License: MIT Python Versions

Turn your monochrome console into a vibrant logging fiesta! 🎉

🌟 Features

  • 🎨 Colorful date and log level outputs
  • 🚦 Easy-to-distinguish log levels
  • 🔧 Customizable and extendable
  • 🚀 Simple to integrate into existing projects
  • 🐍 Pure Python, no extra dependencies (except colorama for Windows support)

📸 See It in Action

Feast your eyes on these beautiful logs:

Colored Logger Demo

🚀 Installation

Get started with a simple pip install:

pip install colored-custom-logger

🎮 Quick Start

Here's a taste of what you can do with Colored Custom Logger:

from colored_custom_logger import CustomLogger

# Create your fabulous logger
logger = CustomLogger.get_logger(__name__)

# Let the colorful logging begin!
logger.debug("🔍 This is a debug message")
logger.info("ℹ️ Here's some info for you")
logger.warning("⚠️ Uh-oh, this is a warning")
logger.error("❌ Oops! We've got an error")
logger.critical("🚨 MAYDAY! MAYDAY! This is critical!")

And voilà! Your console will transform into this:

Logger Output

Documentation

Comprehensive documentation for Colored Custom Logger is available online:

This documentation includes:

  • Installation instructions
  • Usage examples
  • API reference
  • Troubleshooting guide

For developers interested in contributing to the project or setting up the documentation locally:

The documentation is built using MkDocs and hosted on GitHub Pages. It is automatically updated when changes are pushed to the main branch of the repository.

🌈 Color Scheme

Our carefully curated color palette ensures your logs are both beautiful and readable:

  • 🔵 DEBUG: Cool Blue
  • 🟢 INFO: Go Green
  • 🟡 WARNING: Yummy Yellow
  • 🔴 ERROR: Radical Red
  • 🔥 CRITICAL: Blazing Bright Red

🛠️ Advanced Usage

Want to customize your logger further? No problem! Check out our advanced usage guide:

Advanced Usage

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🏷️ Version

The current version of 🌈 colored-custom-logger is 1.6.0.

🙏 Acknowledgements

  • Thanks to the colorama project for making cross-platform colored terminal text output possible.
  • Inspired by all the monochrome loggers out there, waiting for a splash of color.

Made with ❤️ and 🌈 by Robin Collins

Remember, life's too short for boring logs! 🎭🎨

About

A Python logging extension that provides colorized console output for enhanced readability and log level distinction. Seamlessly integrates with the standard logging module.

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages