Skip to main content

A simple interface for the standard Python logging library.

Project description

quick_logger

A simple interface for the standard Python logging library.

About

This is a very simple package designed to setup a logger in one line and allow logging to it with ease.

This package is very simple, if you're looking for advanced logging, just use the base Python logging library.

Installation

Use pip to install.

python -m pip install quick_logger

Usage

Use init_logger to create a log file, and mlog to add a log entry.

Quick Start

init_logger

from quick_logger import init_logger, mlog

init_logger('/path/to/file.log')

By default, the log file will be set to logging.INFO.

mlog

# By default logs are set to "info"
mlog('Logged something!')
# Pass a value to do a different level
mlog('Something went wrong!', 'error')

It's that easy!

"Advanced" Setup

You can set a few options when you use init_logger.

  • level: Defaults to info, accepts critical, error, warning, info, debug, notset.
  • fmt: Defaults to '%(asctime)s:: %(levelname)s:: %(message)s'. See logging.Formatter for details on how to set a Formatter string.
  • datefmt: Defaults to '%Y-%m-%d %H:%M:%S'. See strftime reference.
from quick_logger import init_logger
# Log file set to debug
init_logger('/path/to/file.log', level='debug')
...
# Log file with fmt that includes module.
fmt = '%(asctime)s:: %(module)s:: %(message)s'
# or log file with fmt that just has messages.
fmt = '%(message)s'
init_logger('/path/to/file.log', fmt=fmt)
...
# Omit date, just include the time.
init_logger('/path/to/file.log', datefmt='%H:%M:%S')

Issues/Suggestions

Please make any suggestions or issues on the Github page. Note that this package is meant to be simple, so suggestions should keep that in mind.

License

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

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

quick_logger-0.1.1.tar.gz (3.7 kB view hashes)

Uploaded Source

Built Distribution

quick_logger-0.1.1-py3-none-any.whl (4.0 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