Kleur: HSLuv based color utils & theme generators

I'd like to give special credits to Alexei Boronine and everyone else who contributed to the HSLuv project. This work provided the fundaments to build this package on (and is the only dependency used in it).

Installation

pip install kleur

Library usage

When used as a dependency the kleur package contains convenience wrappers around the HSLuv Python API, as well as utilities for styling console ouput built on top of it.

(API reference to be added)

Command line usage

Preview a color theme

General help

$ kleur theme -h
usage: kleur theme [-h] [-c NAME=HUE (1-360) [NAME=HUE (1-360) ...]]
[-m] [-a] [-s NUMBER_OF_SHADES] [-v NUMBER_OF_VIBRANCES]

options:
  -h, --help            show this help message and exit
  -c, --colors NAME=HUE (1-360) [NAME=HUE (1-360) ...]
  -m, --merge-with-default-theme
  -a, --alt-default-theme
  -s, --number-of-shades NUMBER_OF_SHADES
  -v, --number-of-vibrances NUMBER_OF_VIBRANCES

Preview default theme

$ kleur theme

Preview custom theme

$ kleur theme -c green=143 blue=257 tomato=21 violet=273

Preview custom theme merged with default theme

$ kleur theme -c green=143 blue=257 tomato=21 violet=273 -m

Generate shades (as CSS variables), based one 1 or 2 (hex) colors

General help

$ kleur css -h
usage: kleur css [-h] [-l LABEL] -c COLOR1 [-k COLOR2]
[-s NUMBER_OF_SHADES] [-b] [-i] [-d DYNAMIC_RANGE]

options:
  -h, --help            show this help message and exit
  -l, --label LABEL
  -c, --color1 COLOR1
  -k, --color2 COLOR2
  -s, --number-of-shades NUMBER_OF_SHADES
  -b, --include-black-and-white
  -i, --include-input-shades
  -d, --dynamic-range DYNAMIC_RANGE

Based on one input color

$ kleur css -l tables -c 7ab1e5

With input markers:

$ kleur css -l tables -c 7ab1e5 -i

Based on two input colors

The dynamic range specifies to what degree the hue of the input colors will be used as boundaries:

• Dynamic range 0 (0%):

  The shades will interpolate (or extrapolate) between the input colors.

• Dynamic range between 0 and 1 (between 0% and 100%):

  The shades will interpolate (or extrapolate) between darker / brighter shades of the input colors.

• Dynamic range 1 (100%):

  The shades will interpolate between the darkest & brightest shades of the input colors.

$ kleur css -l bad-guy -c badddd -k aa601f -d 66

With input markers, varying in dynamic range:

$ kleur css -l bad-guy -c badddd -k aa601f -d 0 -i

$ kleur css -l bad-guy -c badddd -k aa601f -d 50 -i

$ kleur css -l bad-guy -c badddd -k aa601f -d 100 -i