tidy-logger 1.0.0

A Python logging utility that generates indented log messages with color-coding for different log levels on the console, and also supports logging to files for better tracking and debugging.

tidy-logger

A repository for a Python logging utility that generates indented log messages with color-coding for different log levels on the console, and also supports logging to files for better tracking and debugging.

[!NOTE] Development for this repository follows the GitFlow workflow.

Installation

To install the tidy-logger package, run the following command:

pip install tidy-logger

Usage

Here’s an example of how to use the tidy-logger utility in a Python project. Start by creating a file named test_module.py, as shown below:

import logging
from tidy_logger import TidyLogger

# Initialize the TidyLogger instance
logger = TidyLogger(app_name="AwesomeApp", app_author="GreatAuthor", log_file_name="journal", console_level=logging.DEBUG)

def some_function() -> None:
    # Example log messages
    logger.debug("This is a debug message - Used for debugging during development.")
    logger.info("This is an info message - General application information.")
    logger.warning("This is a warning message - Something might need attention.")
    logger.error("This is an error message - Something went wrong!")
    logger.critical("This is a critical message - Serious error, action required!")

if __name__ == "__main__":
    some_function()

Run the newly created module using the following command:

python -m test_module.py

Console Output

The logs will appear on the console with color-coded log levels, as shown below:

Options

The environment variable TIDY_LOGGER_LOG_FILE_DIR can be set to specify the log file directory if the log_file_directory argument is not provided during the initialization of TidyLogger. It is recommended to set this environment variable to an absolute path.

Similarly, the environment variable TIDY_LOGGER_LOG_FILE_NAME can be set to set to specify the log file name if the log_file_name argument is not provided.