khcolors 0.3.3

colour name choosing app, for rich and CSS4 palettes

khcolors 🎨

Searching for colour names in terminal

khcolors is a terminal application for searching colour names.

Table of Contents

• Introduction
• Installation
• Usage
• Known Issues
• Release History
• License
• Contact

Introduction

The application helps choosing a colour name from rich or CSS4 palettes. khcolors when given name, presents a list of all the colours containing the name; user can choose an index of a particular colour.

Sources for the colour names are matplotlib.colors and rich.color.ANSI_COLOR_NAMES. Thus the user can easily choose the appropriate colour shade, either working with matplotlib, or rich.

Searching for the colour name involves basic python data structures, lists and dictionaries, since datasets of all the colour names were considered small.

Since the application was designed as auxiliary tool, the command line interface was chosen, with minimalistic, though appealing, text formatting. Styling of the text was achieved mostly with the rich module; in one case ANSI codes were used.

A possibility of using/defining custom colour palettes is to be implemented in the future release.

• Installation

• Building locally

Clone (git clone https://github.com/pykhaz/khcolors.git) or download the package (github.com/pykhaz/khcolors → button/menu "Code" → "Download ZIP"), cd into khcolors and

hatch build
pip install .

• Installing from PyPI

pip install khcolors

Usage

The easiest way to use the application is to type khcolors followed by the name of base colour, eg.

khcolors olive

All the colours containing the name given as the parameter, the base colour, are printed in the terminal, and user is asked to choose one. After confirming the choice, the colour name, or rgb triplet, are copied to clipboard and a confirmation message is displayed.

If the name of a palette is given as a parameter (currently two palettes are available: base and base-bright), the colours in the palette are displayed in the terminal and the user is asked to choose one.

Application options:

• -c / --css -- for using matplotlib CSS4 palettes instead of rich (which is default),

• -r / --rgb -- for copying (r, g, b) tuple, instead of the name.

Screenshots:

khcolors for colour 'salmon', cases for all the options (linux).

khcolors for colour 'salmon', cases for all the options (windows).

Known issues

• Minimal terminal width -- as the width of the terminal grows smaller, the colour lines get messy. When the width drops below below 37 columns, a single colour line gets printed in two rows, which looks bad (but this is hardly a case, since the terminal window width is, in most cases, greater than 37 columns).

Release History

• 0.3.3
  • updated README.md
• 0.3.2
  • new command line argument: -r/--rgb -- for copying (r, g, b) tuple, instead of the name; -a/-all removed
  • options for showing colors palette added: when khcolors called with the name of a palette (base, base-bright), the palette is shown
  • new file, lib.py; functions moved: _get_rgb, _luminosity, byte_rgb, get_contrast_color; vars: LMN_CMPS, LMN_LT, COLOR_PALETTE
  • get_contrast_color: new function for getting foreground/background colors right
  • 3 new functions carved out from get_color_name: get_palette, get_color_choices, find_colors
  • color tiles -- rows of colors printed -- remade completely
• 0.1.1
  • Minor change of the result message
• 0.1.0
  • First working version of the package
• 0.0.1
  • Work in progress

License

The khcolors application is distributed under the MIT license. See LICENSE for more information.

Contact

khaz – [e-mail]