Skip to main content

Color shades generator

Project description

Kleur: HSLuv based color utils & theme generators

Poetry PyPI - Version PyPI - Python Versions

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).

alt text alt text

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

alt text

Preview custom theme

$ kleur theme -c green=133 blue=257 tomato=20

alt text

Preview custom theme merged with default theme

$ kleur theme -c green=133 blue=257 tomato=20 -m

alt text

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

alt text

With input markers:

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

alt text

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

alt text

With input markers, varying in dynamic range:

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

alt text

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

alt text

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

alt text

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kleur-1.3.16.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kleur-1.3.16-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file kleur-1.3.16.tar.gz.

File metadata

  • Download URL: kleur-1.3.16.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for kleur-1.3.16.tar.gz
Algorithm Hash digest
SHA256 b8075b0faaf129a452fbb8da330036525f1e23e84e9bf8bc069f495d6d358638
MD5 81992cf7cb242416ac2d4ea371ad24e8
BLAKE2b-256 536486d14205b36c5dfaebd881e7cd5271d1ca8e5c37ff2b9852e99981612a32

See more details on using hashes here.

Provenance

The following attestation bundles were made for kleur-1.3.16.tar.gz:

Publisher: on-release-tag__publish-to-pypi.yml on githuib/kleur

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kleur-1.3.16-py3-none-any.whl.

File metadata

  • Download URL: kleur-1.3.16-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for kleur-1.3.16-py3-none-any.whl
Algorithm Hash digest
SHA256 38c2475a756da1a7b57d3efa86c2b68d9dd2c59bd27cf1709c1c707b7967dacb
MD5 286f04a7b4bcb3dae2e8d734e05f371d
BLAKE2b-256 12120dc0eb414aa4b4577654d91c0d821b51aea8b547c4c0f42d8ad337e2add5

See more details on using hashes here.

Provenance

The following attestation bundles were made for kleur-1.3.16-py3-none-any.whl:

Publisher: on-release-tag__publish-to-pypi.yml on githuib/kleur

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page