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

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                  # "steelblue"
match.distance              # 10.7703
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

# 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.3.0.tar.gz (22.8 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.3.0-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for colorbrew-0.3.0.tar.gz
Algorithm Hash digest
SHA256 ea9d94da03aabb35f989851ceec2e5610f9c2878776be14d8ef8d89e398e2d93
MD5 7eb2d61272ffe56af618ab8aeb3ca347
BLAKE2b-256 1cce337775007e6ca45dbafc843f79917af639b03574e7296e32500f981cd48b

See more details on using hashes here.

Provenance

The following attestation bundles were made for colorbrew-0.3.0.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.3.0-py3-none-any.whl.

File metadata

  • Download URL: colorbrew-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 17.1 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b764db8c1218f418b35a479d3cd612e1f4aaa8ea64c427a4f6cf3890c92f4915
MD5 e2b3a5b7b37ff8bb7b0fbdc430551d25
BLAKE2b-256 a35533fd6813595a076962a679b2c665a76ed49f90564a66e8c6ddc30acccafd

See more details on using hashes here.

Provenance

The following attestation bundles were made for colorbrew-0.3.0-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