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

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

# 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.2.0.tar.gz (23.1 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.2.0-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for colorbrew-0.2.0.tar.gz
Algorithm Hash digest
SHA256 19236395d9965343e9029180e436eef2f74533315f2ccecacc9e17cb9025dfbb
MD5 b802ac93cf70d6d17007ea25f3056a2a
BLAKE2b-256 33025b6c337100ef5c76b0840d46bba0aba812776bdb66c959fbc329194b420c

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: colorbrew-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 15.7 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5dfe2dee03e74da53a4c79ed21f5fb993d02a10d3c10e77515f707a5ced300e5
MD5 225572bfd4fd880c4b0915786e6872e0
BLAKE2b-256 e8d3b1221c0bba643e37922111548e681f5b4367b1849c6d6cb4a94bcf46c306

See more details on using hashes here.

Provenance

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