Skip to content

induane/logcolor

Repository files navigation

LogColor

Stable Version Documentation Downloads Test Lint

When making command line interfaces, it's often useful to colorize the output to emphasize salient pieces of information or otherwise enhance the user experience. Unfortunately it's quite cumbersome to add colorized outputs to Python log messages.

ColorFormatter

The ColorFormatter is a logging formatter that parses your log messages and adds color codes to the log messages.

example

ColorStripper

The ColorStripper formatter is the inverse of the ColorFormatter. It strips the color information from your messages so that you can log to a file without it being full of color codes.

Installation

I'm on pypi!

$ pip install log_color

Features

  • Simple to use
  • No external dependencies
  • Compatibility with Python 3.7+, PyPy
  • Fast! Compiled binaries are available for some systems!

LogColor honors the NO_COLOR environment variable.

Developer Setup

This project uses uv for dependency management, command running, etc... install it:

$ curl -LsSf https://astral.sh/uv/install.sh | sh

Makefile

If you're on Linux or OSX, there is a Makefile with a number of helpful targets:

  • make check-types Run mypy static code analysis tools
  • make format-code Runs the ruff code formatter
  • make check-code Validates no code formatting errors or import sorting errors (check only, makes no changes)
  • make wheel Build Python .whl file for distribution
  • make test Run the unittests
  • make docs Build the documentation
  • make freeze List all packages (and their version number) installed in the virtual environment
  • make shell Launch an interactive Python shell in the virtual environment context
  • make clean Remove any files that aren't part of the repo (build artifacts, test reports, etc...)
  • make git-clean Runs the git fsck tool, prunes the reflog, etc...

TIP: If you want to force a target to be re-evaluated (i.e. make env) run make with the -B flag to force it to evaluate.

About

Formatter allowing for colored output in log messages

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •