https://github.com/klieret/python-colorlog

For use together with the python3 logging module: Allows to automatically color logging messages based on their level.
https://github.com/klieret/python-colorlog

color colorization colors python3 python3-logging

Last synced: about 1 year ago
JSON representation

For use together with the python3 logging module: Allows to automatically color logging messages based on their level.

• Host: GitHub
• URL: https://github.com/klieret/python-colorlog
• Owner: klieret
• License: lgpl-3.0
• Created: 2016-10-23T16:48:04.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-04-03T18:48:39.000Z (about 9 years ago)
• Last Synced: 2025-02-09T10:11:48.665Z (over 1 year ago)
• Topics: color, colorization, colors, python3, python3-logging
• Language: Python
• Homepage:
• Size: 22.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.rst
  • License: license.txt

Awesome Lists containing this project

README

          
Color for the python3 logging module

====================================

**JUST FOUND OUT THAT THERE's AN OLDER PACKAGE, WHICH IS ALSO BETTER**: Check out `colorlog  `_ from bornyping.

|Build Status|

For use together with the python3 logging module: Allows to

automatically color logging messages based on their level.

.. figure:: https://cloud.githubusercontent.com/assets/13602468/24600851/cf941cdc-1856-11e7-97da-b8cd18568577.png 

   :alt: screenshot

   screenshot

Installation

------------

As this project is still in development, you have to clone the

repository first and then install it with ``pip``:

.. code:: sh

    git clone https://github.com/klieret/python-colorlog

    cd python-colorlog

    pip3 install .

Usage

-----

Minimal example, using one of the predefined color schemes from

``demo_profiles.py``:

.. code:: python

    import logging

    from colored_logging import ColoredStreamHandler

    # Some demo color profile

    from demo_profiles import demo_lcolor_profiles

    logger = logging.getLogger("logger")

    logger.setLevel(logging.DEBUG)

    sh = ColoredStreamHandler(demo_lcolor_profiles['default'])

    logger.addHandler(sh)

    logger.error("Some error message.")

Color profiles are ``int:str`` dictionaries that map level numbers to

formatting strings. To do this platform independent, it is recommended

to use some module like ``colorama``:

.. code:: python

    import logging

    from colored_logging import ColoredStreamHandler

    import colorama

    from colorama import Fore, Back, Style

    colorama.init()

    my_profile = {

        logging.CRITICAL: Fore.RED + Style.BRIGHT,

        logging.ERROR:    Fore.RED + Style.BRIGHT,

        logging.WARNING:  Fore.MAGENTA + Style.BRIGHT,

        logging.INFO:     Fore.GREEN + Style.BRIGHT,

        logging.DEBUG:    Fore.GREEN,

        -1:               Style.RESET_ALL

    }

    sh = ColoredStreamHandler(my_profile)

    (...)

**Note: Always define a reset sequence (to the key -1) that resets the

color/formatting to the default value**

License

-------

The contents of this repository are licensed under the *GNU Lesser

General Public License v3.0*.

.. |Build Status| image:: https://travis-ci.org/klieret/python-colorlog.svg?branch=master

   :target: https://travis-ci.org/klieret/python-colorlog