Welcome to Example Project’s documentation!¶
Introduction¶
Description¶
pycolordetector is a Python package for detecting colors in images. It provides fast and easy way to detect color of a pixel. The applications build through this package will automatically give the name of the color just by double-clicking on them. pycolordetector has been designed to make working with image data both simple and intuitive. It aims to be the fundamental high-level building block for doing practical and real-world analysis on images.
Installation¶
To install pycolordetector, simply use pip:
pip install pycolordetector
License¶
pycolordetector is published under the MIT License.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so.
Contributions¶
All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome.
pycolordetector appreciates help from a wide range of different backgrounds. Work such as high level documentation or code improvements are valuable, and small improvements or fixes are always appreciated. If you are considering larger contributions outside the traditional coding work, please contact us at sunnysinghnitb@gmail.com.
Installation¶
GitHub¶
pip¶
To install Example Project, simply use pip:
pip install pycolordetector
Quickstart¶
This is a short introduction to pycolordetector, geared mainly for new users.
Importing pycolordetector:
from pycolordetector.pycolordetector import colo
Providing Path of Image¶
Give path of your image as an argument to the colo function:
colo("Path_of_your_image")
Get the Colors of the Image¶
Just double-click anywhere on the output image to get the color name and respective R, G, B values. To end the execution of the program, press the “Esc” key.
User Guide¶
The User Guide covers all of Example Project by alpabetical order. This page also functions as an API-reference guide, since it covers all public objects in Example Project.