khcolors 0.3.2

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
• Release History
• License
• Contact
• Acknowledgments

Introduction

The application helps choosing a colour name from rich or CSS4 palettes. Presents a list of all the colours containing name given as a parameter.

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 involved 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

!TODO: about downloading the package/cloning the repo; cding to the directory`

• Building locally

  hatch build
  pip install .
  

• Installing from PyPI

  pip install khcolors
  

  To be implemented.

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.

khcolors usage example -- simple:

<style> pre.example { background-color: black; padding: 0.5em; width: 45em; border: 2px solid white; } body { background-color: none; } div.container { width: 100%; } @keyframes blink { 50% { opacity: 0.0; } } .blink { animation: blink 1s step-start 0s infinite; } </style>

khaz@mainframe:~/spy/dev/cli/utils/khcolors/assets$ khcolors olive
 Choose colour (number):
░ ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺  dark_olive_green3 (175, 215, 95)        ░ (1)
░ ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺  dark_olive_green2 (175, 255, 95)        ░ (2)
░ ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺  dark_olive_green1 (215, 255, 135)       ░ (3)
Color number to copy? (1-3, <Enter> to exit): 2
Color dark_olive_green2 (175, 255, 95) copied to clipboard.
khaz@mainframe:~/spy/dev/cli/utils/khcolors/assets$ ▁

If the name of a palette is given as a parameter (currently two palettes are available: base and base-dark), 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.

khcolors usage example -- option -c:

khaz@mainframe:~/spy/dev/cli/utils/khcolors/assets$ khcolors olive -c

 Choose colour (number):
░ ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺  darkolivegreen (85, 107, 47)            ░ (1) 
░ ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺  olive (128, 128, 0)                     ░ (2) 
░ ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺  olivedrab (107, 142, 35)                ░ (3) 
Color number to copy? (1-3, <Enter> to exit): 2 1
Color  darkolivegreen (85, 107, 47)  copied to clipboard.
khaz@mainframe:~/spy/dev/cli/utils/khcolors/assets$ ▁

khcolors usage example -- option -cr:

khaz@mainframe:~/spy/dev/cli/utils/khcolors/assets$ khcolors blue -cr
 Choose colour (number):
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   aliceblue (240, 248, 255)               ░ (1)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   blue (0, 0, 255)                        ░ (2)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   blueviolet (138, 43, 226)               ░ (3)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   cadetblue (95, 158, 160)                ░ (4)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   cornflowerblue (100, 149, 237)          ░ (5)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   darkblue (0, 0, 139)                    ░ (6)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   darkslateblue (72, 61, 139)             ░ (7)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   deepskyblue (0, 191, 255)               ░ (8)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   dodgerblue (30, 144, 255)               ░ (9)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   lightblue (173, 216, 230)               ░ (10)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   lightskyblue (135, 206, 250)            ░ (11)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   lightsteelblue (176, 196, 222)          ░ (12)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   mediumblue (0, 0, 205)                  ░ (13)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   mediumslateblue (123, 104, 238)         ░ (14)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   midnightblue (25, 25, 112)              ░ (15)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   powderblue (176, 224, 230)              ░ (16)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   royalblue (65, 105, 225)                ░ (17)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   skyblue (135, 206, 235)                 ░ (18)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   slateblue (106, 90, 205)                ░ (19)
░  ⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺⏺   steelblue (70, 130, 180)                ░ (20)
Color number to copy? (1-20, <Enter> to exit): 7
Color  (72, 61, 139) (darkslateblue)  copied to clipboard.
khaz@mainframe:~/spy/dev/cli/utils/khcolors/assets$ ▁

Release History

• 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

Contact

khaz – [e-mail]

License

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