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.

Metadata

Release files for regula-facesdk-webclient 8.5.912.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.5.912.dev0
File Size Uploaded Provenance Actions
regula_facesdk_webclient-8.5.912.dev0.tar.gz 65.3 kB Without provenance Details for regula_facesdk_webclient-8.5.912.dev0.tar.gz

Built distribution (wheel)

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

Total release size: 250.7 kB

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

Download URL regula_facesdk_webclient-8.5.912.dev0.tar.gz
Size 65.3 kB
Tags Source
SHA-256 checksum
How to use checksums
64cd26362a06193facb5ca72bd41a9996593f7ae468e7d849cd915c7d6f06f7a
BLAKE2b-256 checksum
How to use checksums
e34fb034de675e07453409e5f3950c5508a62ecdf7fe69abe46b885e3533b1f7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.14

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

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

Security for regula-facesdk-webclient 8.5.912.dev0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
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