Skip to main content

A Terminal logging library

Project description

Termlog

http://img.shields.io/badge/license-MIT-brightgreen.svg https://badge.fury.io/py/termlog.svg https://github.com/brianbruggeman/termlog/workflows/Latest%20Stable/badge.svg https://codecov.io/gh/brianbruggeman/termlog/branch/stable/graph/badge.svg?token=y6xPnPtcdc

Termlog: A terminal logging library for logging data both as lexed text or json

Motivation

I love f-strings and I wanted a method of displaying beautiful f-strings in command-line interfaces. However, I needed a way of simultaneously creating a developer friendly text log and producing structured text that could be interpreted by a log-shipper in a clustered environment.

Termlog will…

  • wrap print statements with a new method, echo

  • echo is fully compatible with print and is meant to be a drop-in replacement

  • echo can immediately control: color, json, timestamp, time-format outputs on each invocation

  • Alternatively, a set_config command can set the library to use a specific configuration for each subsequent call to echo

Usage

from termlog import blue, echo, red, rgb, set_config

key = 'abc'
value = 123

set_config(color=True, json=False)

echo(f'{red(key)}: {blue(value)}')
echo(f'{rgb(message=key, red=71, green=61, blue=139)}: {blue(value)}')
echo(f'{key}: {blue(value)}', color=True)

Installation

To install termlog, simply run the following.

$ pip install termlog

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

termlog-1.4.0.tar.gz (19.9 kB view details)

Uploaded Source

Built Distribution

termlog-1.4.0-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

Details for the file termlog-1.4.0.tar.gz.

File metadata

  • Download URL: termlog-1.4.0.tar.gz
  • Upload date:
  • Size: 19.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.8.10 Darwin/20.6.0

File hashes

Hashes for termlog-1.4.0.tar.gz
Algorithm Hash digest
SHA256 a6fa0b832697846a27730ba7de860ea5231ef6b801b309061f1a15eb52748827
MD5 cce36403836756a2961b6f040ba2a9db
BLAKE2b-256 543df4fcbdd266ca657dc692378edd5851dd484be0db21cdd6d15b607340667b

See more details on using hashes here.

File details

Details for the file termlog-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: termlog-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 24.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.8.10 Darwin/20.6.0

File hashes

Hashes for termlog-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4fed4be2e790f95c28846b79e9f4434e7f72c34f6760bdb40a990fe625834fc3
MD5 885081b28be07406887050e1b7e4c5d5
BLAKE2b-256 f2892073a506fb09605af0058a84876f297d53f64b61aeb85392725b200fd9e6

See more details on using hashes here.

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