`termcolors`

Simple terminal colour chooser and ANSI code generator utility for Linux, written in Python

Overview

termcolors is a small TUI (terminal user interface) utility for working with true-colour (24-bit) ANSI escape sequences in the terminal. It provides a simple way to generate foreground or background ANSI codes from RGB colour values.

Features

Convert colours, passed as RR;GG;BB strings, to ANSI sequences
Support for foreground and background colours
Batch input (see Usage)
Named palettes generation (see Usage)
Input based on semi-colon separated RGB triplets
Designed as a terminal application.

Dependencies

pyperclip

Installation

pip install termcolors Or install from source: pip install -e .

Usage

Interactive mode: running termcolors without arguments prompts the user for input (e.g. 9;149;9).
Batch input: termcolors -f <file>, where <file> is an .ssv file containing colour codes -- each line should be of the form RR;GG;BB;<fmt>, <fmt> being one of decm, hexa or prct.
Named palette generation -- if .ssv files¹ are stored in the assets folder, termcolors will automatically generate a palette from them, displaying a menu to choose from.

Examples

Interactive mode

    ╭─user at main-frame in ~/some/folder 00-13-48 - 26:93:72
    ╰─∷   termcolors
    termcolors v. 0.9.1 -- interactive mode
    Enter a colour code (R;G;B, decimal), command or help > 9;149;9

Terminal output showing a green colour bar generated by termcolours (RGB 9;149;9)

Commands in interactive mode

fg/bg to copy the current colour to the clipboard (ANSI foreground/background, respectively).
decm: sets conversion format from a decimal triplet.
hexa: sets conversion format from hexadecimal triplet.
prct: sets conversion format from percentage triplet.
help: prints help message.
palette: generates a named palette, from file in the assets folder.
quit: exits the application.

Batch input

termcolors -f <file>

In the batch input mode any .ssv file with colours specified in the correct format² is read. All the parsed colours, along with #hex and int triplets and with the corresponding ANSI codes, are printed to stdout after which the program quits.

Named palette

Typing palette in the interactive mode invokes the method. The user is presented with a menu of available palettes, corresponding to .ssv files stored in the assets folder. he palette is then generated and printed to stdout, after which the program quits.

    ╭─user at main-frame in ~/some/folder 00-13-48 - 26:93:72
    ╰─∷   termcolors
    termcolors v. 0.9.1 -- interactive mode
    Enter a colour code (R;G;B, decimal), command or help > palette
    'ansi16' | 'forest_vibes' | 'gruvbox' | 'khaz' | 'material_basic'
    'navy_light_blue' | 'nord' | 'simple' | 'solarized' | 'turquoise_depths'
    Enter a palette name> khaz

Terminal output showing a green colour bar generated by termcolours (RGB 9;149;9)

Input format

Input semi-colon separated triplets might be in any of the following forms:

decimal, e.g. 10;90;255 (name: decm)
hexadecimal, e.g. a;5a;ff (name: hexa)
percentage, e.g. 0.04;0.355;1 (name: prct)

Invalid input values or formats will result in an error.

License

MIT

Footnotes

File with the first line in the form # palette: <name>; filename: <filenamename>.ssv the palette will show in the menu as a <name> option.↩

See Input format ↩