Metadata-Version: 1.1
Name: inky
Version: 0.0.5
Summary: Inky pHAT Driver
Home-page: http://www.pimoroni.com
Author: Philip Howard
Author-email: phil@pimoroni.com
License: MIT
Project-URL: GitHub, https://www.github.com/pimoroni/inky
Description: Inky
        ====
        
        |Build Status| |Coverage Status| |PyPi Package| |Python Versions|
        
        Python library for the `Inky
        pHAT <https://shop.pimoroni.com/products/inky-phat>`__ and `Inky
        wHAT <https://shop.pimoroni.com/products/inky-what>`__ e-paper displays.
        
        Inky pHAT
        ---------
        
        `Inky pHAT <https://shop.pimoroni.com/products/inky-phat>`__ is a
        212x104 pixel e-paper display, available in red/black/white,
        yellow/black/white and black/white. It's great for nametags and
        displaying very low frequency information such as a daily calendar or
        weather overview.
        
        Inky wHAT
        ---------
        
        `Inky wHAT <https://shop.pimoroni.com/products/inky-what>`__ is a
        400x300 pixel e-paper display available in red/black/white,
        yellow/black/white and black/white. It's got tons of resolution for
        detailed daily todo lists, multi-day weather forecasts, bus timetables
        and more.
        
        Installation
        ============
        
        The Python pip package is named inky, install with:
        
        ::
        
            sudo pip install inky
        
        Usage
        =====
        
        The Inky library contains modules for both the pHAT and wHAT, load the
        InkyPHAT one as follows:
        
        .. code:: python
        
            from inky import InkyPHAT
        
        You'll then need to pick your colour, one of 'red', 'yellow' or 'black'
        and instantiate the class:
        
        .. code:: python
        
            inkyphat = InkyPHAT('red')
        
        If you're using the wHAT you'll need to load the InkyWHAT class from the
        Inky library like so:
        
        .. code:: python
        
            from inky import InkyWHAT
            inkywhat = InkyWHAT('red')
        
        Once you've initialised Inky, there are only three methods you need to
        be concerned with:
        
        Set Image
        ---------
        
        Set a PIL image, numpy array or list to Inky's internal buffer. The
        image dimensions should match the dimensions of the pHAT or wHAT you're
        using.
        
        .. code:: python
        
            inkyphat.set_image(image)
        
        You should use ``PIL`` to create an image. ``PIL`` provides an
        ``ImageDraw`` module which allow you to draw text, lines and shapes over
        your image. See:
        https://pillow.readthedocs.io/en/stable/reference/ImageDraw.html
        
        Set Border
        ----------
        
        Set the border colour of you pHAT or wHAT.
        
        .. code:: python
        
            inkyphat.set_border(colour)
        
        ``colour`` should be one of ``inky.RED``, ``inky.YELLOW``,
        ``inky.WHITE`` or ``inky.BLACK`` with available colours depending on
        your diplay type.
        
        Update The Display
        ------------------
        
        Once you've prepared and set your image, and chosen a border colour, you
        can update your e-ink display with:
        
        .. code:: python
        
            inkyphat.show()
        
        Migrating
        =========
        
        If you're migrating code from the ``inkyphat`` library you'll find that
        much of the drawing and image manipulation functions have been removed
        from Inky. These functions were always supplied by PIL, and the
        recommended approach is to use PIL to create and prepare your image
        before setting it to Inky with ``set_image()``.
        
        .. |Build Status| image:: https://travis-ci.com/pimoroni/inky.svg?branch=master
           :target: https://travis-ci.com/pimoroni/inky
        .. |Coverage Status| image:: https://coveralls.io/repos/github/pimoroni/inky/badge.svg?branch=master
           :target: https://coveralls.io/github/pimoroni/inky?branch=master
        .. |PyPi Package| image:: https://img.shields.io/pypi/v/inky.svg
           :target: https://pypi.python.org/pypi/inky
        .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/inky.svg
           :target: https://pypi.python.org/pypi/inky
        
        0.0.5
        -----
        
        * Enhancement: Added support for red/b/w high-temp Inky wHAT
        
        0.0.4
        -----
        
        * BugFix: Reverted normal red LUTs to correct values
        
        0.0.3
        -----
        
        * Enhancement: Added support for display variant detection
        * Enhancement: Added DocStrings
        * BugFix: Fixed set_border for all colours
        
        0.0.2
        -----
        
        * BugFix: Yellow Inky pHAT now yellow instead of brown/black
        * Enhancement: Performance tweak for set_image
        
        0.0.1
        -----
        
        * Initial Release
        
Keywords: Raspberry Pi e-paper display driver
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Classifier: Topic :: System :: Hardware
