Skip to main content

Detect and recognize colors in images or video

Project description


Documentation | Package


Lint workflow PyPI version Python CircleCI Downloads Documentation Status

ColorDetect works to recognize and identify different colors in an image or video.


pip install ColorDetect

Basic Usage


from colordetect import ColorDetect

user_image = ColorDetect(<path_to_image>)
# return dictionary of color count. Do anything with this

# write color count
# optionally, write any text to the image
user_image.write_text(text="any text")

# save the image after using either of the options (write_color_count/write_text) or both

Resultant image is stored in the string storage_path of choice with the image_name which will default to the current location and out.jpg respectively by default.


from colordetect import VideoColor,col_share

user_video = VideoColor(<path_to_video>)
# return dictionary of color count. Do anything with this result
# to order this rather long result and get only a specific number look up the `col_share` module

You can also get colors at a specific time and extract the frame at that given time.

Project Documentation

For further project documentation, visit ColorDetect's page


Contributions are welcome. Do remember to take a look at the project contribution guidelines


To run tests:



Pre-commit hooks are used to automate linting

  1. Install the git hook scripts

    pre-commit install
  2. (optional) Run against all the files

    pre-commit run --all-files

The installed pre-commit hooks will automatically ensure use of a consistent code format and style whenever one commits changes using git. For full documentation, view the pre-commit docs.

Hall of Code

To the amazing human beings and developers that made this possible.

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

ColorDetect-1.6.0.tar.gz (12.1 kB view hashes)

Uploaded source

Built Distribution

ColorDetect-1.6.0-py3-none-any.whl (14.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page