Skip to main content

Give some color to your (remote) TTY!!

VERSION

DOWNLOADS

TESTS

COVERAGE

WHEEL

Latest PyPI version

Number of PyPI downloads

Travis results

Coveralls results_

Wheel Status

And it is free. Checkout the Source code.

Installation and Usage

Two options: to install it in your system/project:

pip install colorize

And you can use it with:

python -m colorize -h

Or just download the lastest zip and use it with:

python colorize-X.Y.Z.zip -h

Now, you have two ways to use it:

Rendering the output

Just execute:

$ command to execute | python -m colorize

If you need to render both the stdout and the stderr:

$ command to execute |& python -m colorize

This method works well with too long outputs

As runner

Other way to use it:

$ python -m colorize command to execute

This method can do disgusting things with too long outputs.

Options

You can change the output format with the argument -f or --format. It uses the same format that logging, so you can use any of its special variables, like:

You can combine them as you wish. Example:

$ python -m colorize -- echo foo
foo
$ python -m colorize -f "%(asctime)s - %(levelname).2s: %(message)s" -- echo foo
05-29 08:43:09 - IN: foo
$ python -m colorize -f "%(levelname).2s %(asctime)s - %(message)s" -- echo foo
IN 05-29 08:44:17 - foo

Default date format is %m-%d %H:%M:%S, but you can change it with --date-format:

$ python -m colorize -f "%(asctime)s" --date-format="%H:%M:%S" -- echo foo
08:44:17
$ python -m colorize -f "%(asctime)s" --date-format="%H %M %S" -- echo foo
08 44 17

Configuration File

It will find a configuration file in the current directory, in the home directory or in the default path directory. The first one found will be used. So, it will search for:

  • ./.colorize.conf

  • $HOME/.configuration/colorize/colorize.conf

  • /etc/colorize/colorize.conf

The format for this file is very easy: it is a CSV file with next fields:

# regular expression to highlight (quoted) , bold output , foreground color , background color
  "^=+$"                                   , 1           , white            ,
  "^=+$"                                   , true        , white            , black
  "^=+$"                                   , 0           , red              , white
  "^=+$"                                   , false       , brown            , magenta

Available colors:

  • black

  • white

  • red

  • green

  • blue

  • brown

  • gray

  • magenta

  • cyan

And that’s all.

Example to simulate colordiff

To emulate colordiff, just use this configuration file:

"^>.*",                0, blue
"^<.*",                0, red
"^\d+,?\d*c\d+,?\d*$", 0, magenta

That’s enough :D

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

colorize-1.0.3.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

colorize-1.0.3-py2.py3-none-any.whl (9.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file colorize-1.0.3.tar.gz.

File metadata

  • Download URL: colorize-1.0.3.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for colorize-1.0.3.tar.gz
Algorithm Hash digest
SHA256 a7eec7485675be67f9323af7f53fd5b59cc06e5aa717d66ba2c18340c73b0d1e
MD5 87417701f15a34231fcb394b655e3b26
BLAKE2b-256 a741793339aba88de22d691c271b2241871b9358b213802a71fc386de17ec699

See more details on using hashes here.

File details

Details for the file colorize-1.0.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for colorize-1.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 95a6c76522c16be0a54410939ac387b62e1f7fddbf8c298f95085667f232d005
MD5 6d5976406b97e77d49397b08a9051555
BLAKE2b-256 64a671a2e4d8a380a8afad506f2a04813f3cd8637346c77c87c55c2580a11fd6

See more details on using hashes here.

Release history Release notifications | RSS feed

1.1.0

3 files

1.0.4

3 files

This release

1.0.3 This release

2 files

1.0.2

3 files

1.0.1

2 files

1.0.0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page