Metadata-Version: 1.0
Name: thumbor-rekognition
Version: 0.1.0
Summary: Enable thumbor to use AWS rekognition to run face detection
Home-page: https://github.com/yu-liang-kono/thumbor_rekognition
Author: Yu Liang
Author-email: yu.liang@thekono.com
License: MIT License

Copyright (c) 2017 Yu Liang

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, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Description: thumbor_rekognition
        ===========================================================
        
        Enable thumbor to use AWS rekognition to run face detection
        
        |Build Status| |Coverage Status| |PyPI version|
        
        `thumbor`_ is a smart imaging service. It enables on-demand crop,
        resizing and flipping of images. It also features a smart detection of
        important points in the image for better cropping and resizing, using
        opencv face detection algorithms.
        
        `AWS Rekognition`_ can quickly detect faces in image using sophisticated
        deep learning-based visual search and image classification.
        
        thumbor\_rekognition helps to use AWS Rekognition service to do face
        detection in thumbor easily.
        
        Installation
        ------------
        
        .. code:: bash
        
            pip install thumbor_rekognition
        
        Enable detector
        ---------------
        
        Add ``thumbor_rekognition`` to your ``thumbor.conf``. Do not include
        thumbor’s out-of-box face detector.
        
        .. code:: python
        
            DETECTORS = [
                # Do not use out-of-box face detector
                # 'thumbor.detectors.face_detector',
        
                # Include thumbor_rekognition
                'thumbor_rekognition',
                'thumbor.detectors.feature_detector',
            ]
        
        The above configuration tells thumbor that it should run both the facial
        detection and the feature detection. These are mutually exclusive,
        meaning that if a face is detected, the feature detector won’t be run.
        
        AWS Rekognition
        ---------------
        
        Authentication
        ~~~~~~~~~~~~~
        
        Authentication is handled by botocore, see `Boto3 documentation`_.
        
        Region
        ~~~~~
        
        To set the region to use Rekognition service, add ``REKOGNITION_REGION``
        to your ``thumbor.conf``. Default is ``us-east-1``.
        
        .. code:: python
        
            # AWS region for the Rekognition service
            REKOGNITION_REGION = 'us-west-2'
        
        Using it
        --------
        
        After installing thumbor\_rekognition, you can test it by using the
        following URL.
        
        ::
        
            http://<thumbor>:<port>/unsafe/300x300/smart/my.domain.com/picture.png
        
        If you need to see what thumbor is seeing in your image, prepend
        ``/debug`` to all the parameters.
        
        ::
        
            http://<thumbor>:<port>/unsafe/debug/300x300/smart/my.domain.com/picture.png
        
        .. _thumbor: https://github.com/thumbor/thumbor
        .. _AWS Rekognition: http://docs.aws.amazon.com/rekognition/latest/dg/what-is.html
        .. _Boto3 documentation: https://boto3.readthedocs.org/en/latest/guide/quickstart.html#configuration
        
        .. |Build Status| image:: https://travis-ci.org/yu-liang-kono/thumbor_rekognition.svg?branch=master
           :target: https://travis-ci.org/yu-liang-kono/thumbor_rekognition
        .. |Coverage Status| image:: https://coveralls.io/repos/github/yu-liang-kono/thumbor_rekognition/badge.svg?branch=master
           :target: https://coveralls.io/github/yu-liang-kono/thumbor_rekognition?branch=master
        .. |PyPI version| image:: https://badge.fury.io/py/thumbor_rekognition.svg
           :target: https://badge.fury.io/py/thumbor_rekognition
        
Platform: UNKNOWN
