Metadata-Version: 1.1
Name: colorgram.py
Version: 1.0.0
Summary: A Python module for extracting colors from images. Get a palette of any picture!
Home-page: https://github.com/obskyr/colorgram.py
Author: Samuel Messner
Author-email: powpowd@gmail.com
License: MIT
Download-URL: https://github.com/obskyr/colorgram.py/tarball/v1.0.0
Description: colorgram.py
        ============
        **colorgram.py** is a Python library that lets you extract colors from images. Compared to other libraries, the colorgram algorithm's results are more intense.
        
        colorgram.py is a port of `colorgram.js <https://github.com/darosh/colorgram-js>`__, a JavaScript library written by GitHub user `@darosh <https://github.com/darosh>`__. The goal is to have 100% accuracy to the results of the original library (a goal that is met). I decided to port it since I much prefer the results the colorgram algorithm gets over those of alternative libraries - have a look in the next section.
        
        Results
        -------
        .. image:: http://i.imgur.com/11Pohrk.png
            :alt: Results of colorgram.py on a 512x512 image
        
        Time-wise, an extraction of a 512x512 image takes about 66ms (another popular color extraction library, `Color Thief <https://github.com/fengsp/color-thief-py>`__, takes about 105ms).
        
        
        Installation
        ------------
        You can install colorgram.py with `pip <https://pip.pypa.io/en/latest/installing/>`__, as following:
        
        ::
        
            pip install colorgram.py
        
        How to use
        ----------
        
        Example
        '''''''
        
        .. code:: python
        
            import colorgram
        
            # Extract 6 colors from an image.
            colors = colorgram.extract('sweet_pic.jpg', 6)
        
            # colorgram.extract returns Color objects, which let you access
            # RGB, HSL, and what proportion of the image was that color.
            first_color = colors[0]
            rgb = first_color.rgb # e.g. (255, 151, 210)
            hsl = first_color.hsl # e.g. (230, 104, 255)
            proportion  = first_color.proportion # e.g. 0.34
        
        ``colorgram.extract(image, number_of_colors)``
        ''''''''''''''''''''''''''''''''''''''''''''''
        Extract colors from an image. ``image`` may be either a path to a file, or a file-like object. The function will return a list of ``number_of_colors`` ``Color`` objects.
        
        ``colorgram.Color``
        '''''''''''''''''''
        A color extracted from an image. Its properties are:
        * ``Color.rgb`` - The color represented as RGB from 0 to 255, e.g. ``(255, 151, 210)``.
        * ``Color.hsl`` - The color represented as HSL from 0 to 255, e.g. ``(230, 104, 255)``
        * ``Color.proportion``` - The proportion of the image that is in the extracted color from 0 to 1, e.g. ``0.34``
        
        Sorting by HSL
        ''''''''''''''
        Something the original library lets you do is sort the colors you get by HSL. In actuality, though, the colors are only sorted by hue (as of colorgram.js 0.1.5), while saturation and lightness are ignored. To get the corresponding result in colorgram.py, simply do:
        
        .. code:: python
        
            colors.sort(key=lambda c: c.hsl[0])
            # or...
            sorted(colors, key=lambda c: c.hsl[0])
        
        Contact
        -------
        
        If you find a bug in the colorgram.py, or if there's a feature you would like to be added, please `open an issue <https://github.com/obskyr/colorgram.py/issues>`__ on GitHub.
        
        If you have a question about the library, or if you'd just like to talk about, well, anything, that's no problem at all. You can reach me in any of these ways:
        
        * Tweet `@obskyr <https://twitter.com/obskyr>`__
        * `E-mail me <mailto:powpowd@gmail.com>`__
        
        To get a quick answer, Twitter is your best bet.
        
        Enjoy!
        
Keywords: color colors palette extract image picture
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
