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.836rc0

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.836rc0
File Size Uploaded
regula_facesdk_webclient-8.4.836rc0.tar.gz 62.8 kB Details

Built distribution (wheel)

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

Total release size: 241.1 kB

Release files / regula_facesdk_webclient-8.4.836rc0.tar.gz

Download URL regula_facesdk_webclient-8.4.836rc0.tar.gz
Size 62.8 kB
Tags Source
SHA-256 checksum
How to use checksums
7d7c02176f0f5d855aa2dbd7d97992769e8141df79900986f018cc5075e8c2c3
BLAKE2b-256 checksum
How to use checksums
bd09a7b463cd36da3d4ad4d3fc319b1dacc3d47a62b631766d7f5f8266ce0cf0
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.836rc0-py3-none-any.whl

Download URL regula_facesdk_webclient-8.4.836rc0-py3-none-any.whl
Size 178.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7786002ff99b3d1b1f0428f008ab328c76f099b706f96ceace630dd4f8db21f3
BLAKE2b-256 checksum
How to use checksums
5ca04a6fb9ab69d0ed7ad8f2910f0e53926dd7fa90f00003e980a95347963a64
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.836rc0 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