ColorDetect
ColorDetect
Documentation |
Package
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
-
Install the git hook scripts
pre-commit install -
(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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file colordetect-1.6.6.tar.gz.
File metadata
- Download URL: colordetect-1.6.6.tar.gz
- Upload date:
- Size: 8.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
db4b504a5af7812e079b368889458eebcac18343e617a8ec11dab3be8b8c5f17
|
|
| MD5 |
27555f84740c3a86d54974445e2de67b
|
|
| BLAKE2b-256 |
39a69889476b7223d3da0c009479af717e9dc059e34dc1b0932e495a2fa12d0b
|
File details
Details for the file colordetect-1.6.6-py3-none-any.whl.
File metadata
- Download URL: colordetect-1.6.6-py3-none-any.whl
- Upload date:
- Size: 10.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
736e62b8e75727b5c55890dfc89105c09aa861d6651f4cb91d21b16f7868795e
|
|
| MD5 |
27e8e711c13c157247137540b380396b
|
|
| BLAKE2b-256 |
3b84fded574546fc4c39b655db64262d3b5a3195388d744cc26959cd1e23f778
|
