Skip to main content

A lightweight, zero-dependency Python library for color manipulation.

Project description

ColorBrew

A lightweight, zero-dependency Python library for working with colors.

Features

  • Parse colors from hex strings (#3498db, #fff, 3498db)
  • Parse CSS function strings (rgb(52, 152, 219), hsl(204, 70%, 53%))
  • Parse CSS named colors (cornflowerblue, red, etc.)
  • Convert between hex, RGB, HSL, and CMYK formats
  • Input validation with clear error messages
  • 148 built-in CSS named colors
  • Immutable Color class with format properties and dunder methods
  • CSS/HTML-ready output (rgb(), rgba(), hsl(), hsla(), hex)
  • Format string support (f"{color:rgb}", f"{color:hsl}")
  • Reverse name lookup — find the closest CSS named color with distance score
  • Color manipulation — lighten, darken, saturate, desaturate, rotate hue, invert, grayscale, mix
  • Photoshop-style blend modes — multiply, screen, overlay, soft light, hard light, difference
  • Palette generation — complementary, analogous, triadic, split-complementary, tetradic
  • WCAG accessibility — luminance, contrast ratio, AA/AAA compliance checks
  • Color temperature — warm/cool/neutral classification, Kelvin estimation

Installation

pip install colorbrew

Requires Python 3.12+. Zero runtime dependencies.

Quick Start

from colorbrew import Color

# Create from any format
c = Color("#3498db")
c = Color(52, 152, 219)
c = Color("rgb(52, 152, 219)")
c = Color("cornflowerblue")

# Alternate constructors
c = Color.from_hsl(204, 70, 53)
c = Color.from_cmyk(76, 31, 0, 14)
c = Color.from_name("cornflowerblue")

# Access format properties
c.rgb                       # (52, 152, 219)
c.hex                       # "#3498db"
c.hsl                       # (204, 70, 53)
c.cmyk                      # (76, 31, 0, 14)

# CSS output
c.css_rgb                   # "rgb(52, 152, 219)"
c.css_hsl                   # "hsl(204, 70%, 53%)"
c.css_hex                   # "#3498db"
c.css_rgba(0.5)             # "rgba(52, 152, 219, 0.5)"
c.css_hsla(0.8)             # "hsla(204, 70%, 53%, 0.8)"

# Format strings
f"{c:rgb}"                  # "rgb(52, 152, 219)"
f"{c:hsl}"                  # "hsl(204, 70%, 53%)"
f"{c:hex}"                  # "#3498db"

# Reverse name lookup
match = c.closest_name
match.name                  # "dodgerblue"
match.distance              # 42.9418
match.exact                 # False

# Manipulation (all return new Color instances)
c.lighten(20)               # lighter color
c.darken(10)                # darker color
c.saturate(15)              # more vivid
c.desaturate(15)            # more muted
c.rotate(180)               # shift hue
c.invert()                  # RGB inverse
c.grayscale()               # remove saturation
c.mix(Color("red"), 0.5)    # blend two colors

# Blend modes
c.blend(Color("white"), "multiply")   # multiply blend
c.blend(Color("black"), "screen")     # screen blend

# Palette generation
c.complementary()              # opposite hue
c.analogous()                  # 3 neighboring hues
c.triadic()                    # 2 colors at 120° intervals
c.split_complementary()        # 2 colors flanking the complement
c.tetradic()                   # 3 colors at 90° intervals

# Accessibility (WCAG 2.1)
c.luminance                    # relative luminance (0.0-1.0)
c.contrast(Color("white"))     # contrast ratio (1.0-21.0)
c.meets_aa(Color("white"))     # True if passes WCAG AA
c.meets_aaa(Color("white"))    # True if passes WCAG AAA

# Color temperature
c.temperature                  # "warm", "cool", or "neutral"
c.kelvin                       # estimated Kelvin (1000-40000)

# Iteration and comparison
r, g, b = c                 # unpack RGB
Color("#ff0000") == Color("red")  # True

Development

uv sync
uv run pytest
uv run ruff check src/

License

MIT

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

colorbrew-0.5.1.tar.gz (27.0 kB view details)

Uploaded Source

Built Distribution

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

colorbrew-0.5.1-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file colorbrew-0.5.1.tar.gz.

File metadata

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

File hashes

Hashes for colorbrew-0.5.1.tar.gz
Algorithm Hash digest
SHA256 8c8cdd461680c848e4aaad60986b153471c6a776621c83e2c4a5b96fc43882a5
MD5 0837faec240b932f73388d4b85e47031
BLAKE2b-256 b412776a554fed9968d54b1bc69ec1215c4f44a751cd0b87a4f4979b1fa87bd7

See more details on using hashes here.

Provenance

The following attestation bundles were made for colorbrew-0.5.1.tar.gz:

Publisher: publish.yml on zfoq/colorbrew

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

File details

Details for the file colorbrew-0.5.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for colorbrew-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b8b48161b0e1fcbb5c7dc40f3848d4e3924aa95088787d3830fdf05273d326d7
MD5 a813701f90637939aba859666b4e4133
BLAKE2b-256 f0471fc6f0a03488d80d3c366eb223a8dd92976cdb1dc310a31c8b764832e545

See more details on using hashes here.

Provenance

The following attestation bundles were made for colorbrew-0.5.1-py3-none-any.whl:

Publisher: publish.yml on zfoq/colorbrew

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