Metadata-Version: 2.1
Name: ColorDetect
Version: 1.5.1
Summary: Detect and recognize colors in images or video
Home-page: https://github.com/MarvinKweyu/ColorDetect
Author: Marvin Kweyu
Author-email: mkweyu1@gmail.com
License: MIT
Description: # ColorDetect
        
        <p align="center">
          <b>ColorDetect</b><br>
          <a href="https://colordetect.readthedocs.io/en/latest/">Documentation</a> |
          <a href="https://pypi.org/project/ColorDetect/">Package</a> 
          <br><br>
          <img src="./img/ColorDetect.png" alt="ColorDetect">
        </p>
        
        ![Lint workflow](https://github.com/MarvinKweyu/ColorDetect/actions/workflows/lint.yml/badge.svg?branch=master)
        [![PyPI version](https://badge.fury.io/py/ColorDetect.svg)](https://pypi.org/project/ColorDetect/)
        [![Python](https://img.shields.io/badge/python-3.6%7C3.7%7C3.8%7C3.9-green)](https://pypi.org/project/ColorDetect/)
        [![CircleCI](https://circleci.com/gh/MarvinKweyu/ColorDetect.svg?style=svg)](https://circleci.com/gh/MarvinKweyu/ColorDetect)
        [![Downloads](https://pepy.tech/badge/colordetect)](https://pypi.org/project/ColorDetect/)
        [![Documentation Status](https://readthedocs.org/projects/colordetect/badge/?version=master)](https://colordetect.readthedocs.io/en/master/)
        
        ColorDetect works to recognize and identify different colors in an image or video.
        
        ### Installation
        
        ```bash
        pip install ColorDetect
        ```
        
        ### Basic Usage
        
        #### Images
        
        ```python
        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
        
        ```python
        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
        ```
        
        ### Project Documentation
        
        For further project documentation, visit [ColorDetect's page](https://colordetect.readthedocs.io/en/latest/)
        
        ### Contributions
        
        Contributions are welcome.
        Do remember to take a look at the project [contribution guidelines](https://github.com/MarvinKweyu/ColorDetect/blob/master/CONTRIBUTING.rst)
        
        #### Tests
        
        To run tests:
        
        ```bash
        pytest
        ```
        
        #### Pre-commit
        
        Pre-commit hooks are used to automate linting
        
        1. Install the git hook scripts
           ```shell
           pre-commit install
           ```
        
        1. (optional) Run against all the files
            ```shell
           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](https://pre-commit.com/).
        
        ### Hall of Code
        
        To the amazing human beings and developers that made this possible.
        
        <div align="center">
            <a href="https://github.com/MarvinKweyu/ColorDetect/graphs/contributors">
                <img alt="contributors' avatars" src="https://contrib.rocks/image?repo=MarvinKweyu/ColorDetect" />
            </a>
        </div>
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.6
Description-Content-Type: text/markdown
