regula-facesdk-webclient 8.1.448.dev0__tar.gz

regula_facesdk_webclient-8.1.448.dev0/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: regula_facesdk_webclient
+Version: 8.1.448.dev0
+Summary: Regula's FaceSDK web python client
+Home-page: https://regulaforensics.com
+Author: Regula Forensics, Inc.
+Author-email: support@regulaforensics.com
+Keywords: face recognition,facesdk,regulaforensics,regula
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: certifi>=2024.07.04
+Requires-Dist: six>=1.10
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: urllib3<3.0.0,>=1.25.3
+Requires-Dist: vistir<=0.6.1,>=0.4.0
+Requires-Dist: idna==3.7
+Requires-Dist: requests>=2.32.3
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Requires-Dist: lazy-imports==1.0.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Regula Face SDK web API Python 3.9+ client
+
+[![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-8c0a56?style=flat-square)](https://github.com/regulaforensics/FaceSDK-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://faceapi.regulaforensics.com/)
+
+## ⚠️ Warning: Package Name Changed
+## Package name has been changed from `regula.facesdk.webclient` to `regula_facesdk_webclient`
+
+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/FaceSDK-web-python-client/issues).
+You are invited to contribute [new features, fixes, or updates](https://github.com/regulaforensics/FaceSDK-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_facesdk_webclient` is on the Python Package Index (PyPI):
+
+```bash
+pip install regula_facesdk_webclient
+```
+
+Or using `pipenv`
+```bash
+pipenv install regula_facesdk_webclient
+```
+
+## Example
+Performing request:
+
+```python
+from regula.facesdk.webclient import MatchImage, MatchRequest
+from regula.facesdk.webclient.ext import FaceSdk, DetectRequest
+from regula.facesdk.webclient.gen.model.image_source import ImageSource
+
+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 FaceSdk(host="http://0.0.0.0:41101") as sdk:
+    images = [
+        MatchImage(index=1, data=face_1_bytes, type=ImageSource.LIVE),
+        MatchImage(index=2, data=face_1_bytes, type=ImageSource.DOCUMENT_RFID),
+        MatchImage(index=3, data=face_2_bytes)
+    ]
+    match_request = MatchRequest(images=images)
+    match_response = sdk.match_api.match(match_request)
+
+    detect_request = DetectRequest(image=face_1_bytes)
+    detect_response = sdk.match_api.detect(detect_request)
+```
+
+You can find more detailed guide and run this sample in [example](./example) folder.

regula_facesdk_webclient-8.1.448.dev0/README.md

@@ -0,0 +1,57 @@
+# Regula Face SDK web API Python 3.9+ client
+
+[![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-8c0a56?style=flat-square)](https://github.com/regulaforensics/FaceSDK-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://faceapi.regulaforensics.com/)
+
+## ⚠️ Warning: Package Name Changed
+## Package name has been changed from `regula.facesdk.webclient` to `regula_facesdk_webclient`
+
+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/FaceSDK-web-python-client/issues).
+You are invited to contribute [new features, fixes, or updates](https://github.com/regulaforensics/FaceSDK-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_facesdk_webclient` is on the Python Package Index (PyPI):
+
+```bash
+pip install regula_facesdk_webclient
+```
+
+Or using `pipenv`
+```bash
+pipenv install regula_facesdk_webclient
+```
+
+## Example
+Performing request:
+
+```python
+from regula.facesdk.webclient import MatchImage, MatchRequest
+from regula.facesdk.webclient.ext import FaceSdk, DetectRequest
+from regula.facesdk.webclient.gen.model.image_source import ImageSource
+
+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 FaceSdk(host="http://0.0.0.0:41101") as sdk:
+    images = [
+        MatchImage(index=1, data=face_1_bytes, type=ImageSource.LIVE),
+        MatchImage(index=2, data=face_1_bytes, type=ImageSource.DOCUMENT_RFID),
+        MatchImage(index=3, data=face_2_bytes)
+    ]
+    match_request = MatchRequest(images=images)
+    match_response = sdk.match_api.match(match_request)
+
+    detect_request = DetectRequest(image=face_1_bytes)
+    detect_response = sdk.match_api.detect(detect_request)
+```
+
+You can find more detailed guide and run this sample in [example](./example) folder.

regula_facesdk_webclient-8.1.448.dev0/regula/facesdk/webclient/__init__.py

@@ -0,0 +1,15 @@
+# compatibility import
+from regula.facesdk.webclient.ext import MatchImage, MatchRequest
+from regula.facesdk.webclient.gen.models.face_sdk_result import FaceSDKResult
+from regula.facesdk.webclient.gen.models.face_sdk_result_code import FaceSDKResultCode
+from regula.facesdk.webclient.gen.models.match_image_detection import MatchImageDetection
+from regula.facesdk.webclient.gen.models.match_image_result import MatchImageResult
+from regula.facesdk.webclient.gen.models.match_response import MatchResponse
+
+FaceRecognitionResult = FaceSDKResult
+FaceRecognitionResultCode = FaceSDKResultCode
+CompareImage = MatchImage
+CompareImageDetection = MatchImageDetection
+CompareImageResult = MatchImageResult
+CompareRequest = MatchRequest
+CompareResponse = MatchResponse

regula_facesdk_webclient-8.1.448.dev0/regula/facesdk/webclient/ext/__init__.py

@@ -0,0 +1,5 @@
+from regula.facesdk.webclient.ext.api import MatchApi, FaceSdk
+from regula.facesdk.webclient.ext.common import Base64String
+from regula.facesdk.webclient.ext.models import MatchRequest
+from regula.facesdk.webclient.ext.models import MatchImage
+from regula.facesdk.webclient.ext.models import DetectRequest

regula_facesdk_webclient-8.1.448.dev0/regula/facesdk/webclient/ext/api/__init__.py

@@ -0,0 +1,3 @@
+from regula.facesdk.webclient.ext.api.match_api import MatchApi
+from regula.facesdk.webclient.ext.api.person_api import PersonApi
+from regula.facesdk.webclient.ext.api.sdk import FaceSdk

regula_facesdk_webclient-8.1.448.dev0/regula/facesdk/webclient/ext/api/group_api.py

@@ -0,0 +1,11 @@
+from regula.facesdk.webclient.gen.api.group_api import GroupApi as GenGroupApi
+from regula.facesdk.webclient.gen.models.group import Group
+from regula.facesdk.webclient.gen.models.group_to_create import GroupToCreate
+
+
+class GroupApi(GenGroupApi):
+    def create_group(self, group_name: str, metadata=None, **kwargs) -> Group:
+        if metadata is None:
+            metadata = {}
+        group_to_create = GroupToCreate(name=group_name, metadata=metadata)
+        return super().create_group(group_to_create, **kwargs)

regula_facesdk_webclient-8.1.448.dev0/regula/facesdk/webclient/ext/api/match_api.py

@@ -0,0 +1,20 @@
+from regula.facesdk.webclient.gen import Configuration, ApiClient
+from regula.facesdk.webclient.gen.api import MatchApi as GenMatchApi
+
+
+class MatchApi(GenMatchApi):
+    def __init__(self, host=None, debug=False, verify_ssl=False, api_client=None):
+        if api_client:
+            super().__init__(api_client)
+        else:
+            configuration = Configuration(host=host)
+            configuration.debug = debug
+            configuration.verify_ssl = verify_ssl
+
+            super().__init__(ApiClient(configuration=configuration))
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        pass

regula_facesdk_webclient-8.1.448.dev0/regula/facesdk/webclient/ext/api/person_api.py

@@ -0,0 +1,20 @@
+import base64
+
+from regula.facesdk.webclient.gen.models.add_image_to_person_request import AddImageToPersonRequest
+from regula.facesdk.webclient.gen.models.add_image_to_person_request_image import AddImageToPersonRequestImage
+from regula.facesdk.webclient.gen.models.add_image_to_person_response import AddImageToPersonResponse
+from regula.facesdk.webclient.gen.api.person_api import PersonApi as GenPersonApi
+from regula.facesdk.webclient.gen.models.person import Person
+from regula.facesdk.webclient.gen.models.person_fields import PersonFields
+from uuid import UUID
+
+class PersonApi(GenPersonApi):
+    def add_image_to_person(self, person_id: UUID, content: bytes, content_type: str = None, **kwargs) -> AddImageToPersonResponse:
+        base_image = base64.b64encode(content).decode("UTF-8")
+        image = AddImageToPersonRequest(image=AddImageToPersonRequestImage(contentType=content_type, content=base_image))
+        return super().add_image_to_person(person_id, image, **kwargs)
+
+    def create_person(self, person_fields: PersonFields, **kwargs) -> Person:
+        if person_fields.metadata is None:
+            person_fields.metadata = {}
+        return super().create_person(person_fields, **kwargs)

regula_facesdk_webclient-8.1.448.dev0/regula/facesdk/webclient/ext/api/sdk.py

@@ -0,0 +1,30 @@
+from regula.facesdk.webclient.ext.api import MatchApi
+from regula.facesdk.webclient.ext.api import PersonApi
+from regula.facesdk.webclient.ext.api.group_api import GroupApi
+from regula.facesdk.webclient.ext.api.search_api import SearchApi
+from regula.facesdk.webclient.gen import ApiClient, Configuration, HealthcheckApi, Liveness20Api
+
+
+class FaceSdk:
+    def __init__(self, host=None, debug=None, verify_ssl=True, api_client=None):
+        if api_client:
+            self.__api_client = api_client
+        else:
+            configuration = Configuration(host=host)
+            configuration.debug = debug
+            configuration.verify_ssl = verify_ssl
+
+            self.__api_client = ApiClient(configuration=configuration)
+
+        self.match_api = MatchApi(api_client=self.__api_client)
+        self.person_api = PersonApi(api_client=self.__api_client)
+        self.group_api = GroupApi(api_client=self.__api_client)
+        self.search_api = SearchApi(api_client=self.__api_client)
+        self.healthcheck = HealthcheckApi(api_client=self.__api_client)
+        self.liveness = Liveness20Api(api_client=self.__api_client)
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        pass

regula_facesdk_webclient-8.1.448.dev0/regula/facesdk/webclient/ext/api/search_api.py

@@ -0,0 +1,13 @@
+import base64
+
+from regula.facesdk.webclient.gen.api.search_api import SearchApi as GenSearchApi
+from regula.facesdk.webclient.gen.models.search_request import SearchRequest
+from regula.facesdk.webclient.gen.models.search_result import SearchResult
+
+
+class SearchApi(GenSearchApi):
+    def search(self, search_request: SearchRequest, **kwargs) -> SearchResult:
+        image = search_request.image
+        if image is not None:
+            search_request.image.content = base64.b64encode(image.content).decode("utf-8") if image.content else None
+        return super().search(search_request, **kwargs)

regula_facesdk_webclient-8.1.448.dev0/regula/facesdk/webclient/ext/common.py

@@ -0,0 +1,7 @@
+import base64
+
+Base64String = str
+
+
+def bytes_to_base64(payload: bytes):
+    return base64.b64encode(payload).decode("utf-8")

regula_facesdk_webclient-8.1.448.dev0/regula/facesdk/webclient/ext/models/__init__.py

@@ -0,0 +1,6 @@
+from regula.facesdk.webclient.ext.models.match_request import MatchRequest
+from regula.facesdk.webclient.ext.models.match_image import MatchImage
+from regula.facesdk.webclient.ext.models.detect_request import DetectRequest
+
+CompareRequest = MatchRequest
+CompareImage = MatchImage

regula_facesdk_webclient-8.1.448.dev0/regula/facesdk/webclient/ext/models/detect_request.py

@@ -0,0 +1,30 @@
+from typing import Union
+
+from regula.facesdk.webclient.ext.common import Base64String, bytes_to_base64
+from regula.facesdk.webclient.gen import ApiValueError
+from regula.facesdk.webclient.gen.models.process_param import ProcessParam
+from regula.facesdk.webclient.gen.models import DetectRequest as GetDetectRequest
+
+
+class DetectRequest(GetDetectRequest):
+    def __init__(
+            self,
+            image: Union[Base64String, bytes],
+            process_param: ProcessParam = None,
+            tag=None,
+            env=None,
+            tenant=None
+    ):
+        if not image:
+            raise ApiValueError(f"image: expected <not empty> - obtained <{image}>", "image")
+
+        if isinstance(image, bytes):
+            image = bytes_to_base64(image)
+
+        super().__init__(
+            image=image,
+            tag=tag,
+            process_param=process_param,
+            env=env,
+            tenant=tenant
+        )

regula_facesdk_webclient-8.1.448.dev0/regula/facesdk/webclient/ext/models/match_image.py

@@ -0,0 +1,19 @@
+from typing import Union
+
+from regula.facesdk.webclient.ext.common import Base64String, bytes_to_base64
+from regula.facesdk.webclient.gen import ApiValueError
+from regula.facesdk.webclient.gen.models.image_source import ImageSource
+from regula.facesdk.webclient.gen.models import MatchImage as GenMatchImage
+
+
+class MatchImage(GenMatchImage):
+    def __init__(self, index=None, type=None, data: Union[Base64String, bytes] = None, detect_all=None):
+        if not data:
+            raise ApiValueError(f"compare image {index} data: expected <not empty>")
+
+        if not type:
+            type = ImageSource.LIVE
+        if isinstance(data, bytes):
+            data = bytes_to_base64(data)
+
+        super().__init__(index=index, type=type, data=data, detectAll=detect_all)

regula_facesdk_webclient-8.1.448.dev0/regula/facesdk/webclient/ext/models/match_request.py

@@ -0,0 +1,34 @@
+from typing import List, Union
+
+from regula.facesdk.webclient.ext.common import Base64String
+from regula.facesdk.webclient.ext.models.match_image import MatchImage
+from regula.facesdk.webclient.gen import ApiValueError
+from regula.facesdk.webclient.gen.models import MatchRequest as GenMatchRequest
+
+
+class MatchRequest(GenMatchRequest):
+    def __init__(
+            self,
+            images: List[Union[MatchImage, Base64String, bytes]],
+            output_image_params=None,
+            tag=None,
+            env=None,
+            tenant=None
+    ):
+        if not images:
+            raise ApiValueError(f"compare request images: expected size <more than 1>")
+
+        input_images = []
+        for index, item in enumerate(images):
+            if isinstance(item, MatchImage):
+                input_images.append(item)
+            else:
+                input_images.append(MatchImage(index, None, item))
+
+        super().__init__(
+            images=input_images,
+            output_image_params=output_image_params,
+            tag=tag,
+            env=env,
+            tenant=tenant
+        )