Skip to content

A development tool for grabbing the dominant color or representative color palette from an image

License

Notifications You must be signed in to change notification settings

LanceGin/haishoku

Repository files navigation

Haishoku

haishoku is a JP word, it means palette in English.

Haishoku is a development tool for grabbing the dominant color or representative color palette from an image, it depends on Python3 and Pillow.

Feature

  1. Grab the dominant color from a image.

  2. Grab the representative color palette from a image.

  3. From v1.1.4, Haishoku could load a image from remote url.

Demo

demo

( original image's source: dribbble )

Installation

pip3 install haishoku

or maybe you should use

python3 -m pip install haishoku

Api

• loadHaishoku( image )

from haishoku.haishoku import Haishoku
haishoku = Haishoku.loadHaishoku(image)

it will return a Haishoku instance, and you can use haishoku.dominant and haishoku.palette to get the image's dominant color and color palette

Also, you can use more immediately api to get them or show them temporarily, just like below:

• getDominant( image )

from haishoku.haishoku import Haishoku
dominant = Haishoku.getDominant(image)

returns: (R, G, B) tuple

• showDominant( image )

from haishoku.haishoku import Haishoku
Haishoku.showDominant( image )

it will open a temporary image to show the dominant color.

• getPalette( image )

from haishoku.haishoku import Haishoku
palette = Haishoku.getPalette( image )

returns: [(percentage, (R, G, B)), (percentage, (R, G, B)), ...] Array length <= 8

• showPalette( image )

from haishoku.haishoku import Haishoku
Haishoku.showPalette( image )

it will open a temporary image to show the palette.

中文文档

中文文档