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

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

# 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.1.0.tar.gz (21.4 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.1.0-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for colorbrew-0.1.0.tar.gz
Algorithm Hash digest
SHA256 aa86e14ce27d0992e1d5d87cb8580e944f41512b5243b790c7014d8a07d4f1e2
MD5 a21ecae59db2c0f1c954c7ad25c8e431
BLAKE2b-256 a290cdb01c674056868187ffaf7586efc4dff47336f7542739db281b4b3624f5

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: colorbrew-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.3 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb449edcdb904ccae50a31d070e56a00bf77f84ea384087ab58a09f0b5e1dbca
MD5 d9883a67e1c0d5afe83a765b736df2f4
BLAKE2b-256 cbee0431e4e7e58b864b1a325a2aa5e4ce4977988838f1ebf1ed7c544b0915f2

See more details on using hashes here.

Provenance

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