colorthief-v3 3.3.1

Python port of the npm colorthief package API for dominant color, palettes, and semantic swatches.

colorthief-v3

Python 3 package based on the latest npm colorthief API (colorthief@3.3.1).

It extracts dominant colors, palettes, semantic swatches, and rich color objects from images. The Python package uses Pillow for image decoding and keeps the npm package's core option names: color_count, quality, color_space, ignore_white, white_threshold, alpha_threshold, and min_saturation.

Install

pip install .

Usage

from colorthief_v3 import get_color, get_palette, get_swatches

color = get_color("photo.jpg")
print(color.hex())       # "#e84393"
print(color.css())       # "rgb(232, 67, 147)"
print(color.text_color)  # "#000000" or "#ffffff"

palette = get_palette("photo.jpg", color_count=6)
print([c.hex() for c in palette])

swatches = get_swatches("photo.jpg")
print(swatches["Vibrant"].color.hex() if swatches["Vibrant"] else None)

CamelCase aliases are also exported for easier migration from JavaScript: getColor, getPalette, getSwatches, getPaletteProgressive, and createColor.

CLI

colorthief-v3 color photo.jpg --json
colorthief-v3 palette photo.jpg --count 6 --color-space oklch
colorthief-v3 swatches photo.jpg --css

Source

This package was generated from the npm package metadata for colorthief@3.3.1. See vendor/colorthief-npm.json.