Metadata-Version: 2.1
Name: regula.facerecognition.webclient
Version: 3.0.0b0
Summary: Regula's Face Recognition python client
Home-page: https://mobile.regulaforensics.com
Author: Regula Forensics, Inc.
Author-email: support@regulaforensics.com
License: UNKNOWN
Description: # Regula Face Recognition web API Python 3.5+ client
        
        [![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-8c0a56?style=flat-square)](https://github.com/regulaforensics/FaceRecognition-web-openapi)
        [![documentation](https://img.shields.io/badge/docs-en-f6858d?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
        [![live](https://img.shields.io/badge/live-demo-0a8c42?style=flat-square)](https://api.regulaforensics.com/)
        
        Face recognition as easy as reading two bytes.
        
        If you have any problems with or questions about this client, please contact us
        through a [GitHub issue](https://github.com/regulaforensics/FaceRecognition-web-python-client/issues).
        You are invited to contribute [new features, fixes, or updates](https://github.com/regulaforensics/FaceRecognition-web-python-client/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), large or small; 
        We are always thrilled to receive pull requests, and do our best to process them as fast as we can.
        See [dev guide](./dev.md)
        
        ## Install package
        `regula.facerecognition.webclient` is on the Python Package Index (PyPI):
        
        ```bash
        pip install regula.facerecognition.webclient
        ```
        
        Or using `pipenv`
        ```bash
        pipenv install regula.facerecognition.webclient
        ```
        
        ## Example
        Performing request:
        ```python
        from regula.facerecognition.webclient import *
        
        with open("face1.jpg", "rb") as f:
            face_1_bytes = f.read()
        
        with open("face2.jpg", "rb") as f:
            face_2_bytes = f.read()
        
        
        with MatchingApi(host="http://0.0.0.0:41101/api") as api:
            images = [
                CompareImage(index=1, data=face_1_bytes, type=ImageSource.LIVE),
                CompareImage(index=2, data=face_1_bytes, type=ImageSource.DOCUMENT_RFID),
                CompareImage(index=3, data=face_2_bytes)
            ]
            compare_request = CompareRequest(images=images)
            compare_response = api.compare(compare_request)
            
            detect_request = DetectRequest(face_1_bytes)
            detect_response = api.detect(detect_request)
        ```
        
        You can find more detailed guide and run this sample in [example](./example) folder.
        
Keywords: face-recognition-client,face recognition,facer,regulaforensics,regula
Platform: UNKNOWN
Requires-Python: >=3.5
Description-Content-Type: text/markdown
