Metadata-Version: 2.1
Name: chromaterm
Version: 0.3.96
Summary: Colorize your output using RegEx
Home-page: https://github.com/hSaria/ChromaTerm
Author: hSaria
Author-email: ping@heysaria.com
License: GPLv2
Description: # ChromaTerm
        
        A tool for colorizing the output of a terminal.
        
        -   [About](#about)
        -   [Installation](#installation)
        -   [Usage](#usage)
        -   [Highlight Rules](#highlight-rules)
            -   [Description](#description)
            -   [RegEx](#regex)
            -   [Color](#color)
            -   [Group](#group)
        -   [Help](#help)
        
        # About
        
        ChromaTerm (`ct`) reads from standard input and colors it according to user-configurable rules.
        
        Think of ChromaTerm like `grep`; just pipe things into it. However, unlike other programs which line-buffer, `ct` works with interactive applications, like `ssh`. In fact, I have `ssh() { /usr/bin/ssh $* | ct; }` in my `.bash_profile` to give my sessions color.
        
        Here's an example using the rules in the default configuration file:
        
        ![alt text](https://github.com/hSaria/ChromaTerm/raw/master/.github/junos-show-interface.png "Example output")
        
        # Installation
        
            pip3 install chromaterm
        
        > If you have the legacy version of ChromaTerm, be sure to uninstall it first.
        >
        >     # If installed using HomeBrew
        >     brew uninstall chromaterm
        >
        >     # If installed from source
        >     git clone -b legacy git@github.com:hSaria/ChromaTerm.git
        >     cd ChromaTerm--/src/ && ./configure && make uninstall
        
        # Usage
        
        By default, ChromaTerm reads `.chromaterm.yml` in your home directory. As an example, run the following:
        
            echo "Jul 14 12:28:19: Message from 1.2.3.4" | ct
        
        > During installation, the default config file was copied to home directory.
        
        # Highlight Rules
        
        All of the highlight rules are placed under the `rules` array in the configuration file. Here's an example config file:
        
        ```yaml
        rules:
        - description: My first rule colors the foreground
          regex: hello.+world
          color: f#ff0000
        
        - description: Background this time, but just for "there"
          regex: Hey (there), buddy
          color: b#ff0000
          group: 1
        ```
        
        ## Description
        
        Optional. It's purely for your sake.
        
        ## RegEx
        
        The RegEx engine used is Python's [re](https://docs.python.org/3/library/re.html#regular-expression-syntax).
        
        ## Color
        
        The color is a hex string prefixed by `b` for background (e.g. `b#123456`) and `f` for foreground (e.g. `f#abcdef`).
        
        You can color the foreground and background by separating them with a space, like `b#123456 f#abcdef`.
        
        ## Group
        
        Optional. By default, the entire match is colored. That can be changed to a specific group in the `regex`.
        
        # Help
        
        If you've got any questions or suggestions, please open up an issue (always appreciated).
        
Platform: UNKNOWN
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Terminals
Classifier: Topic :: Utilities
Requires: PyYAML
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
