Skip to main content

Personally opinionated logger in Python.

Project description

Python-PyLogg

A personally opinionated logging package in Python.

Features:

  • Colors in console.
  • Saving log messages into a single file.
  • Support for named sub-loggers.
  • Override of log levels and settings from the main function.
  • Eight levels of verbosity.
  • Wrapping and shortening of long messages.
  • Automatic logging of elapsed times for long processes.

Installation

You can install this package from PyPI with pip.

pip install -U pylogg

Usage

Set up the logger in the main script. These settings will override the settings set using pylogg.New() instance.

import pylogg as log

# Set output file
log.setFile(open("test.log", "w+"))

# Show date and times on console
log.setConsoleTimes(show=True)

# Save date and times to file
log.setFileTimes(show=True)

# Set global logging level
log.setLevel(log.DEBUG)

# Override the level of a named sub-logger
log.setLoggerLevel('module', log.INFO)

# Use
log.info("Hello world")

# Close the log file
log.close()

Use sub-logger from the modules.

import time
import pylogg

# Create a new sub-logger
log = pylogg.New('module')

# Use
def run():
    log.Trace("Running module ...")

    # Support for f strings.
    log.Debug("2 + 2 = {} ({answer})", 2 + 2, answer=True)


def timing():
    # Get the timer instance
    t1 = log.Info("Started process ...")

    # long process
    time.sleep(2)

    # Call timer.done() to log elapsed time.
    t1.done("Process completed.")

Note: Full logg package must be imported. Use import pylogg, do not use from pylogg import New.

See the examples for more details.

About

LICENSE MIT Copyright 2023 Akhlak Mahmood

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

pylogg-0.1.17.tar.gz (7.1 kB view hashes)

Uploaded Source

Built Distribution

pylogg-0.1.17-py3-none-any.whl (7.4 kB view hashes)

Uploaded Python 3

Supported by

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