colored log messages and banners from commandline and python
Project description
Version v1.4.6 as of 2020-07-31, see changelog
lib_log_utils
this library makes it easy to log colored messages from python and from the commandline. Text Wrapping is supported.
whenever possible, it tries to autodetect the correct settings for colored output.
currently the settings for TRAVIS and BINDER/Jupyter are detected automatically
automated tests, Travis Matrix, Documentation, Badges, etc. are managed with PizzaCutter (cookiecutter on steroids)
Python version required: 3.6.0 or newer
tested on linux “bionic” with python 3.6, 3.7, 3.8, 3.8-dev, pypy3
good code coverage, codestyle checking ,mypy static type checking ,tested under Linux, macOS, Windows, automatic daily builds and monitoring
Try it Online
You might try it right away in Jupyter Notebook by using the “launch binder” badge, or click here
Usage
Python
import the module and check the code - it is very easy and documented there
as soon as I have some time, this will be completed (help welcome)
Commandline
Usage:
log_util (-h | --version | --program_info)
log_util [Options] "<message>"
log_util "<message>" [Options]
Options:
-h, --help show help
--version show version
--program_info show Program Info
Arguments
- message
the message to log
Options
option |
description |
---|---|
-l –level <level> |
the log level as number or predefined value, default = INFO |
-b –banner |
log as banner |
-w –width <width> |
the width of the message or the banner, if text wrap is used, default = 140 |
-s –silent <True|False> ** |
disables the output if set to “True” (not case sensitive)**, default = False |
-q –quiet |
disables the output (as flag), default = False |
-f –force |
take precedence over environment settings, default = False |
–wrap –nowrap |
use text wrap (this is the default value), default = True |
–traceback –no-traceback |
show traceback on commandline error, default = False |
-e –extended |
extended log format, default = plain |
-p –plain |
plain log format, default = plain |
-c –colortest |
color test |
**This makes it possible to silence messages elegantly in a shellscript:
#!/bin/bash
# disable deprecation messages
DEP_MSG_OFF="True"
...
...
log_util -l warning "some deprecation message" --silent=${DEP_MSG_OFF}
log_util -l info "another deprecation message" --silent=${DEP_MSG_OFF}
...
log levels
Text |
Integer |
---|---|
NOTSET |
0 |
SPAM |
5 |
DEBUG |
10 |
VERBOSE |
15 |
INFO |
20 |
NOTICE |
25 |
WARNING |
30 |
SUCCESS |
35 |
ERROR |
40 |
CRITICAL |
50 |
Environment Settings
environment variable |
function |
---|---|
LOG_UTIL_FMT |
the log format - either “plain”, “extended” or a custom formatting string, default = plain |
LOG_UTIL_LEVEL |
the level of the logger, one of the predefined log levels, or “0” - “50”, default = 0 |
LOG_UTIL_WIDTH |
the banner width if text wrap is used, must be >=”10”, default = 140 |
LOG_UTIL_WRAP |
if text wrap should be used, must be True or False (not case sensitive), default = True |
LOG_UTIL_QUIET |
if the logger is used at all - must be True or False (not case sensitive), default = False |
COLOREDLOGS_LOG_FORMAT |
|
COLOREDLOGS_DATE_FORMAT |
|
COLOREDLOGS_FIELD_STYLES |
|
COLOREDLOGS_LEVEL_STYLES |
environment settings take precedence over commandline arguments, unless –force is passed to the commandline
EXAMPLES
# multi-line banner
log_util -l warning "Line1${IFS}Line2${IFS}Line3"
# only show log messages from level WARNING upwards
export LOG_UTIL_LEVEL=WARNING
log_util -l info "spam" # this is not shown
log_util -l error "ham" # this is shown
# reset the log_level to 0 (the default value)
unset LOG_UTIL_LEVEL
Usage from Commandline
Usage: log_util [OPTIONS] [MESSAGE]
colored log messages and banners from commandline and python
Options:
--version Show the version and exit.
-e, --extended extended log format
-p, --plain plain log format
-b, --banner log as banner
-w, --width INTEGER wrap width, default=140
--wrap / --nowrap wrap text
-s, --silent TEXT disable logging if "True"
-q, --quiet disable logging as flag
-f, --force take precedence over environment settings
-l, --level TEXT log level as number or predefined Level
--program_info get program info
-c, --colortest color test
--traceback / --no-traceback return traceback information on cli
-h, --help Show this message and exit.
Installation and Upgrade
Before You start, its highly recommended to update pip and setup tools:
python -m pip --upgrade pip
python -m pip --upgrade setuptools
python -m pip --upgrade wheel
to install the latest release from PyPi via pip (recommended):
# install latest release from PyPi
python -m pip install --upgrade lib_log_utils
# test latest release from PyPi without installing (can be skipped)
python -m pip install lib_log_utils --install-option test
to install the latest development version from github via pip:
# normal install
python -m pip install --upgrade git+https://github.com/bitranox/lib_log_utils.git
# to test without installing (can be skipped)
python -m pip install git+https://github.com/bitranox/lib_log_utils.git --install-option test
# to install and upgrade all dependencies regardless of version number
python -m pip install --upgrade git+https://github.com/bitranox/lib_log_utils.git --upgrade-strategy eager
include it into Your requirements.txt:
# Insert following line in Your requirements.txt:
# for the latest Release on pypi:
lib_log_utils
# for the latest development version :
lib_log_utils @ git+https://github.com/bitranox/lib_log_utils.git
# to install and upgrade all modules mentioned in requirements.txt:
python -m pip install --upgrade -r /<path>/requirements.txt
to install the latest development version from source code:
# cd ~
$ git clone https://github.com/bitranox/lib_log_utils.git
$ cd lib_log_utils
# to test without installing (can be skipped)
python setup.py test
# normal install
python setup.py install
via makefile: makefiles are a very convenient way to install. Here we can do much more, like installing virtual environments, clean caches and so on.
# from Your shell's homedirectory:
$ git clone https://github.com/bitranox/lib_log_utils.git
$ cd lib_log_utils
# to run the tests:
$ make test
# to install the package
$ make install
# to clean the package
$ make clean
# uninstall the package
$ make uninstall
Requirements
following modules will be automatically installed :
## Project Requirements
click
bitranox_coloredlogs @ git+https://github.com/bitranox/bitranox_coloredlogs.git
cli_exit_tools @ git+https://github.com/bitranox/cli_exit_tools.git
lib_parameter @ git+https://github.com/bitranox/lib_parameter.git
lib_platform @ git+https://github.com/bitranox/lib_platform.git
lib_programname @ git+https://github.com/bitranox/lib_programname.git
Acknowledgements
special thanks to “uncle bob” Robert C. Martin, especially for his books on “clean code” and “clean architecture”
Contribute
I would love for you to fork and send me pull request for this project. - please Contribute
License
This software is licensed under the MIT license
—
Changelog
new MAJOR version for incompatible API changes,
new MINOR version for added functionality in a backwards compatible manner
new PATCH version for backwards compatible bug fixes
v1.4.6
2020-07-31: fix travis build
v0.4.5
2020-07-29: fix environ.pop issue in doctest
v0.4.4
- 2020-07-29: feature release
use the new pizzacutter template
v0.4.3
- 2020-07-27: feature release
use cli_exit_tools
add banner parameter, to temporary disable/enable banner
v0.4.2
2020-07-23: separate travis profile
v0.4.1
2020-07-23: change color profiles
v0.4.0
- 2020-07-23: feature release
correct print_exception_traceback is stdout, stderr = None
added formatting parameter, custom log formatter
v0.3.0
- 2020-07-22: feature release
autodetect travis settings
autodetect binder/jupyter settings
v0.2.0
- 2020-07-22: feature release
log_exception_traceback and print_exception_traceback will also report stdout, stderr if present
v0.1.4
- 2020-07-17: feature release
bump coverage
v0.1.3
- 2020-07-17: feature release
comprehensive –colortest
automatically select 8 colors profile for travis
v0.1.2
- 2020-07-16: feature release
store settings in environment for commandline use
cleanup
release on pypi
fix cli test
enable traceback option on cli errors
jupyter notebook
v0.1.1
- 2020-07-06: patch release
new click cli
use PizzaCutter Template
v0.0.2
development
v0.0.1
2019-09-03: Initial public release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for lib_log_utils-1.4.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b53429dcc866828d3ee8c50cb87ecd5b4d9a67979898892f4e7d378571b67331 |
|
MD5 | 78188e44f4b6ca55c3e13c723e5cd646 |
|
BLAKE2b-256 | 7c674e6c4b8756d4b36232d9a9705ab3803b7f16c1f669bc384a5934645d1f8f |