python-colorize/README at master · w256/python-colorize · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
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 git@github.com: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 <kokuban.kumasan@gmail.com>

---