Home
Welcome to Pylette, the easy-to-use Python library for extracting color palettes from images!
Documentation: https://qtiptip.github.io/Pylette/
Source code: qTipTip/Pylette
What is Pylette?
Pylette is a powerful yet user-friendly library designed to help you extract color palettes from images. Whether you're working on computer graphics, visualizations, or generative art, Pylette makes it easy to create visually appealing color sets.
Key features:
- Extract color palettes from images
- Support for various color modes (RGB, RGBa, HSV, etc.)
- Random color selection from palettes
- Command-line interface for quick palette extraction
Getting Started
Installation
You can easily install Pylette using pip:
Or if you prefer using Poetry:
Quick Start Guide
Here's how to extract a color palette from an image and work with it in Python:
Extracting a Color Palette
from Pylette import extract_colors
palette = extract_colors(image='image.jpg', palette_size=10)
# Access colors by index
most_common_color = palette[0]
least_common_color = palette[-1]
# Get color information
print(most_common_color.rgb)
print(most_common_color.hls)
print(most_common_color.hsv)
# Display the palette, and save the image to file
palette.display(save_to_file=True)
# Save palette's color values to CSV
palette.to_csv(filename='color_palette.csv', frequency=True)
# Pick random colors
random_color = palette.random_color(N=1, mode='uniform')
random_colors = palette.random_color(N=100, mode='frequency')
This will give you a palette of 10 colors, sorted by frequency. The image is automatically resized to 256x256 pixels for faster processing. See the reference documentation for a complete list of available methods and attributes.
Command Line Tool
Pylette also comes with a handy command-line tool. Here's a quick overview of its usage:
Command Line Usage
pylette --help
Usage: pylette [OPTIONS]
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --filename PATH [default: None] │
│ --image-url TEXT [default: None] │
│ --mode [KM|MC] [default: KM] │
│ --n INTEGER [default: 5] │
│ --sort-by [frequency|luminance] [default: luminance] │
│ --stdout --no-stdout [default: stdout] │
│ --out-filename PATH [default: None] │
│ --display-colors --no-display-colors [default: no-display-colors] │
│ --colorspace [rgb|hsv|hls] [default: rgb] │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Example Palettes
Check out these palettes extracted using Pylette! The top row corresponds to extraction using K-Means, and the bottom row corresponds to Median-Cut extraction. The colors are sorted by luminosity.
| Original Image | Extracted Palette |
|---|---|
 |
  |
 |
  |
 |
  |
How Pylette Works
Pylette uses various color quantization algorithms to extract the most representative colors from your images. Currently, it supports:
- K-Means clustering
- Median-Cut algorithm
We'd Love Your Feedback And Contributions!
Pylette is an ongoing project, and we're always looking to improve it. If you have any suggestions, questions, or just want to share how you're using Pylette, please don't hesitate to reach out, or make a pull request on our GitHub repository.
Happy color extracting!