colorize
==========

Program Overview
--------------

With this program, you can add color to the standard output.
The simplest usage is to describe the command line as follow:

    $ colorize (Target string)

This command prints the entered characters in red.
For attaching any color, this command has four options.


1, -c and -r option
C option specifies the color.
Supported color is as follows:

    + black
    + red
    + green
    + yellow
    + blue
    + purple
    + cyan
    + under

R option specifies the details of the target string by regular expressions.
In other words, the following two commands to print the same color.

    $ colorize  (Target string)
    $ colorize -c red -r '^.*$' (Target string)

2, -s option
By using configuration file,
it is possible to configure more complex coloring rules as follows:

    $ colorize -s (coloring-scheme) (Text containing the target string )

The configuration file format is as follows:

    (coloring-rule name):
        (rule name):
            regular:"(Regular expression for the target string)"
            color:(color)

Regular expressions must be enclosed in ".
The default file path is '~/.colorize.yml'.


3, -f option
You can also load a differenet file as follows:

    $ colorize -f '(configuration file path)'-s (coloring-scheme) (Text containing the target string )


You can use the standard input to the input of the target string.

    $ tail -f (somefiles) | colorize -s (coloring-scheme)



How to install
--------------

+--- Download and Install

$ cd /usr/local/share/
$ git clone [email protected]:kokukuma/python-colorize.git
$ cd python-colorize
$ sudo ln -s /usr/local/share/python-colorize/colorize.py /usr/bin/colorize
$ ln -s /usr/local/share/python-colorize/config.yml ~/.colorize.yml



Example usage
-------------

+--- Simplest Use

$ colorize karino
    --> print "karino" in red


+--- Specify the color

$ colorize -c green karino
    --> print "karino" in green


+--- Specify the color and range by regular expression

$ colorize -c green -r '^ka' karino
    --> print "karino" in green only 'ka'.


+--- Color by using color configuration file (~/.colorize.yml)

$ colorize -s errorlog "Where is error"
    --> print "Where is error". Only error is red.


+--- Color by using color configuration file (~/file/test_colorize.yml)

$ colorize -f '~/file/test_colorize.yml' -s errorlog "Where is error"
    --> print "Where is error". Only error is red.


+--- Add color to the standard output

$ ping google.com | colorizle -s ping
    --> ping output. IP addresses are shown in yellow and underlined.


Example config.yml
-------------

+--- For error syntax highlight
errorlog:
    rule1:
        regular:"\[[Ee]rror\]"
        color:red
    rule2:
        regular:"\[emerg\]"
        color:green


+--- For ping syntax highlight
ping:
    rule1:
        regular:"[0-9]*\.[0-9]*\.[0-9]*\.[0-9]*"
        color:blue
    rule2:
        regular:"[0-9]*\.[0-9]*\.[0-9]*\.[0-9]*"
        color:under
    rule3:
        regular:"from"
        color:red



Author
------

Tatsuya Karino <[email protected]>

---