Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Regula Face SDK web API Python 3.9+ client

OpenAPI documentation live

⚠️ 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. You are invited to contribute new features, fixes, or updates, 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

Install package

regula_facesdk_webclient is on the Python Package Index (PyPI):

pip install regula_facesdk_webclient

Or using pipenv

pipenv install regula_facesdk_webclient

Example

Performing request:

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 folder.

Release files for regula-facesdk-webclient 8.4.832.dev0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for regula-facesdk-webclient 8.4.832.dev0
File Size Uploaded
regula_facesdk_webclient-8.4.832.dev0.tar.gz 62.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for regula-facesdk-webclient 8.4.832.dev0
File Interpreter ABI Platform
regula_facesdk_webclient-8.4.832.dev0-py3-none-any.whl Python 3 none any Details

Total release size: 241.2 kB

Release files / regula_facesdk_webclient-8.4.832.dev0.tar.gz

Download URL regula_facesdk_webclient-8.4.832.dev0.tar.gz
Size 62.9 kB
Tags Source
SHA-256 checksum
How to use checksums
3f457ae253bb269e23a7bd1e627f8ba103c795e66dce404b60c0017b9f16176e
BLAKE2b-256 checksum
How to use checksums
5bf3e6687fca5402065ff949f94c63d4e12ee46b886e78b9a370bf07c8b2c9ca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.14

Release files / regula_facesdk_webclient-8.4.832.dev0-py3-none-any.whl

Download URL regula_facesdk_webclient-8.4.832.dev0-py3-none-any.whl
Size 178.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a7c4c0fc18937f66e6590671c65c73700dbbc01bcaaf9fe1b6f173958b913a7c
BLAKE2b-256 checksum
How to use checksums
c46354a954ac61a87b0a79d94f2127c13ccdd43bdeb52a2a70f2975bbac631f7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.14

Release history Release notifications | RSS feed

This release

8.4.832.dev0 This release

2 release files

6.3.32

2 release files

6.1.0

2 release files

5.2.4

2 release files

5.2.3

2 release files

5.2.2

2 release files

5.2.1

2 release files

5.2.0

2 release files

5.1.1

2 release files

5.1.0

2 release files

4.1.8

2 release files

4.1.7

2 release files

4.1.6

2 release files

4.1.5

2 release files

4.1.4

2 release files

4.1.3

2 release files

4.1.2

2 release files

4.1.1

2 release files

4.1.0

2 release files

3.1.1

2 release files

3.1.0

2 release files

3.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page