Skip to main content

ColorDetect

ColorDetect
Documentation | Package

ColorDetect

Lint workflow PyPI version Python CircleCI Downloads Documentation Status

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

Installation

pip install ColorDetect

Basic Usage

Images

from colordetect import ColorDetect


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

# write color count
user_image.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
user_image.save_image(<storage_path>,<image_name>)

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.

Videos

from colordetect import VideoColor,col_share

user_video = VideoColor(<path_to_video>)
# return dictionary of color count. Do anything with this result
user_video.get_video_frames(progress=True)
# 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

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

Tests

To run tests:

pytest

Pre-commit

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.

Metadata

Release files for ColorDetect 1.6.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ColorDetect 1.6.2
File Size Uploaded Provenance Actions
colordetect-1.6.2.tar.gz 12.1 kB Without provenance Details for colordetect-1.6.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ColorDetect 1.6.2
File Interpreter ABI Platform Actions
ColorDetect-1.6.2-py3-none-any.whl Python 3 none any Details for ColorDetect-1.6.2-py3-none-any.whl

Total release size: 26.6 kB

Release files / colordetect-1.6.2.tar.gz

Download URL colordetect-1.6.2.tar.gz
Size 12.1 kB
Tags Source
SHA-256 checksum
How to use checksums
46052d36e6384897aa041b12fe88647811d37b3fff163fa36d91764065c01f49
BLAKE2b-256 checksum
How to use checksums
5ee7bc463ed1ec2135a483f5d0e578a611388b8a7fcceb675455fe8bdc422b14
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.4

Release files / ColorDetect-1.6.2-py3-none-any.whl

Download URL ColorDetect-1.6.2-py3-none-any.whl
Size 14.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
26d374bb564d9dd84d5306de7ad6daf7affea547b856633d3022deb0129a81cc
BLAKE2b-256 checksum
How to use checksums
b7ce5f1399898be03cf9be81a86f5b0b451ce6eb7be9858267af9d0d71ab6190
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.4

Security for ColorDetect 1.6.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page