Version v1.4.15 as of 2023-07-21 see Changelog_
|build_badge| |codeql| |license| |jupyter| |pypi| |pypi-downloads| |black| |codecov| |cc_maintain| |cc_issues| |cc_coverage| |snyk|
.. |build_badge| image:: https://github.com/bitranox/lib_log_utils/actions/workflows/python-package.yml/badge.svg :target: https://github.com/bitranox/lib_log_utils/actions/workflows/python-package.yml
.. |codeql| image:: https://github.com/bitranox/lib_log_utils/actions/workflows/codeql-analysis.yml/badge.svg?event=push :target: https://github.com//bitranox/lib_log_utils/actions/workflows/codeql-analysis.yml
.. |license| image:: https://img.shields.io/github/license/webcomics/pywine.svg :target: http://en.wikipedia.org/wiki/MIT_License
.. |jupyter| image:: https://mybinder.org/badge_logo.svg :target: https://mybinder.org/v2/gh/bitranox/lib_log_utils/master?filepath=lib_log_utils.ipynb
.. for the pypi status link note the dashes, not the underscore ! .. |pypi| image:: https://img.shields.io/pypi/status/lib-log-utils?label=PyPI%20Package :target: https://badge.fury.io/py/lib_log_utils
.. |codecov| image:: https://img.shields.io/codecov/c/github/bitranox/lib_log_utils :target: https://codecov.io/gh/bitranox/lib_log_utils
.. |cc_maintain| image:: https://img.shields.io/codeclimate/maintainability-percentage/bitranox/lib_log_utils?label=CC%20maintainability :target: https://codeclimate.com/github/bitranox/lib_log_utils/maintainability :alt: Maintainability
.. |cc_issues| image:: https://img.shields.io/codeclimate/issues/bitranox/lib_log_utils?label=CC%20issues :target: https://codeclimate.com/github/bitranox/lib_log_utils/maintainability :alt: Maintainability
.. |cc_coverage| image:: https://img.shields.io/codeclimate/coverage/bitranox/lib_log_utils?label=CC%20coverage :target: https://codeclimate.com/github/bitranox/lib_log_utils/test_coverage :alt: Code Coverage
.. |snyk| image:: https://snyk.io/test/github/bitranox/lib_log_utils/badge.svg :target: https://snyk.io/test/github/bitranox/lib_log_utils
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/lib-log-utils :target: https://pypi.org/project/lib-log-utils/ :alt: PyPI - Downloads
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, Github Actions, Documentation, Badges, etc. are managed with PizzaCutter <https://github .com/bitranox/PizzaCutter>_ (cookiecutter on steroids)
Python version required: 3.8.0 or newer
tested on recent linux with python 3.8, 3.9, 3.10, 3.11, 3.12-dev, pypy-3.9, pypy-3.10 - architectures: amd64
good code coverage <https://codeclimate.com/github/bitranox/lib_log_utils/test_coverage>, flake8 style checking ,mypy static type checking ,tested under Linux, macOS, Windows <https://github.com/bitranox/lib_log_utils/actions/workflows/python-package.yml>, automatic daily builds and monitoring
Try it Online_Usage_Usage from Commandline_Installation and Upgrade_Requirements_Acknowledgements_Contribute_Report Issues <https://github.com/bitranox/lib_log_utils/blob/master/ISSUE_TEMPLATE.md>_Pull Request <https://github.com/bitranox/lib_log_utils/blob/master/PULL_REQUEST_TEMPLATE.md>_Code of Conduct <https://github.com/bitranox/lib_log_utils/blob/master/CODE_OF_CONDUCT.md>_License_Changelog_You might try it right away in Jupyter Notebook by using the "launch binder" badge, or click here <https://mybinder.org/v2/gh/{{rst_include. repository_slug}}/master?filepath=lib_log_utils.ipynb>_
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)
.. code-block:: bash
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
message the message to log
=========================== ==================================================================================== option description =========================== ==================================================================================== -l --level the log level as number or predefined value, default = INFO -b --banner log as banner -w --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:
.. code-block:: bash
#!/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}
...
========= =========== Text Integer ========= =========== NOTSET 0 SPAM 5 DEBUG 10 VERBOSE 15 INFO 20 NOTICE 25 WARNING 30 SUCCESS 35 ERROR 40 CRITICAL 50 ========= ===========
======================== =======================================================================================
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 as described in coloredlogs <https://coloredlogs.readthedocs.io/en/latest/api.html#environment-variables>_
COLOREDLOGS_DATE_FORMAT as described in coloredlogs <https://coloredlogs.readthedocs.io/en/latest/api.html#environment-variables>_
COLOREDLOGS_FIELD_STYLES as described in coloredlogs <https://coloredlogs.readthedocs.io/en/latest/api.html#environment-variables>_
COLOREDLOGS_LEVEL_STYLES as described in coloredlogs <https://coloredlogs.readthedocs.io/en/latest/api.html#environment-variables>_
======================== =======================================================================================
environment settings take precedence over commandline arguments, unless --force is passed to the commandline
.. code-block:: bash
# 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
.. code-block::
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.
.. code-block::
python -m pip --upgrade pip
python -m pip --upgrade setuptools
.. code-block::
python -m pip install --upgrade lib_log_utils
.. code-block::
python -m pip install --upgrade lib_log_utils[test]
.. code-block::
python -m pip install --upgrade git+https://github.com/bitranox/lib_log_utils.git
.. code-block::
# 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
.. code-block::
# cd ~
$ git clone https://github.com/bitranox/lib_log_utils.git
$ cd lib_log_utils
python -m pip install -e .[test]
.. code-block:: shell
# 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
following modules will be automatically installed :
.. code-block:: bash
## Project Requirements
click
coloredlogs
cli_exit_tools
lib_parameter
lib_platform
lib_programname
I would love for you to fork and send me pull request for this project.
please Contribute <https://github.com/bitranox/lib_log_utils/blob/master/CONTRIBUTING.md>_This software is licensed under the MIT license <http://en.wikipedia.org/wiki/MIT_License>_
2023-07-21:
- require minimum python 3.8
- remove python 3.7 tests
- introduce PEP517 packaging standard
- introduce pyproject.toml build-system
- remove mypy.ini
- remove pytest.ini
- remove setup.cfg
- remove setup.py
- remove .bettercodehub.yml
- remove .travis.yml
- update black config
- clean ./tests/test_cli.py
- add codeql badge
- move 3rd_party_stubs outside the src directory to ./.3rd_party_stubs
- add pypy 3.10 tests
- add python 3.12-dev tests
2022-06-02: update to github actions checkout@v3 and setup-python@v3
2022-03-29: remedy mypy type error in lob_log_utils_cli
2022-03-25:
2020-10-09: service release - update travis build matrix for linux 3.9-dev - update travis build matrix (paths) for windows 3.9 / 3.10
2020-08-08: service release - fix documentation - fix travis - deprecate pycodestyle - implement flake8
2020-08-01: fix doctests in windows
2020-08-01: fix pypi deploy
2020-07-31: fix travis build
2020-07-29: fix environ.pop issue in doctest
2020-07-29: feature release - use the new pizzacutter template
2020-07-27: feature release - use cli_exit_tools - add banner parameter, to temporary disable/enable banner
2020-07-23: separate travis profile
2020-07-23: change color profiles
2020-07-23: feature release - correct print_exception_traceback is stdout, stderr = None - added formatting parameter, custom log formatter
2020-07-22: feature release - autodetect travis settings - autodetect binder/jupyter settings
2020-07-22: feature release - log_exception_traceback and print_exception_traceback will also report stdout, stderr if present
2020-07-17: feature release - bump coverage
2020-07-17: feature release - comprehensive --colortest - automatically select 8 colors profile for travis
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
2020-07-06: patch release - new click cli - use PizzaCutter Template
development
2019-09-03: Initial public release
FAQs
colored log messages and banners from commandline and python
We found that lib-log-utils demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.