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
Metadata
1 maintainer
Release files for ColorDetect 1.6.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| colordetect-1.6.6.tar.gz | 8.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| colordetect-1.6.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 18.7 kB
Release files / colordetect-1.6.6.tar.gz
| Download URL | colordetect-1.6.6.tar.gz |
|---|---|
| Size | 8.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
db4b504a5af7812e079b368889458eebcac18343e617a8ec11dab3be8b8c5f17
|
|
BLAKE2b-256 checksum How to use checksums |
39a69889476b7223d3da0c009479af717e9dc059e34dc1b0932e495a2fa12d0b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / colordetect-1.6.6-py3-none-any.whl
| Download URL | colordetect-1.6.6-py3-none-any.whl |
|---|---|
| Size | 10.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
736e62b8e75727b5c55890dfc89105c09aa861d6651f4cb91d21b16f7868795e
|
|
BLAKE2b-256 checksum How to use checksums |
3b84fded574546fc4c39b655db64262d3b5a3195388d744cc26959cd1e23f778
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
