regula-facesdk-webclient


Nameregula-facesdk-webclient JSON
Version 7.1.318 PyPI version JSON
download
home_pagehttps://regulaforensics.com
SummaryRegula's FaceSDK web python client
upload_time2025-07-09 08:29:18
maintainerNone
docs_urlNone
authorRegula Forensics, Inc.
requires_python>=3.9
licenseNone
keywords face recognition facesdk regulaforensics regula
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # 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, thumbnails=True)
    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.

Raw data

            {
    "_id": null,
    "home_page": "https://regulaforensics.com",
    "name": "regula-facesdk-webclient",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "face recognition, facesdk, regulaforensics, regula",
    "author": "Regula Forensics, Inc.",
    "author_email": "support@regulaforensics.com",
    "download_url": "https://files.pythonhosted.org/packages/29/e9/65c5ce587e53616b0a1113e5e4ee1fec3be110e125ee83d559e98edc20e3/regula_facesdk_webclient-7.1.318.tar.gz",
    "platform": null,
    "description": "# Regula Face SDK web API Python 3.9+ client\n\n[![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-8c0a56?style=flat-square)](https://github.com/regulaforensics/FaceSDK-web-openapi)\n[![documentation](https://img.shields.io/badge/docs-en-f6858d?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)\n[![live](https://img.shields.io/badge/live-demo-0a8c42?style=flat-square)](https://faceapi.regulaforensics.com/)\n\n## \u26a0\ufe0f Warning: Package Name Changed\n## Package name has been changed from `regula.facesdk.webclient` to `regula_facesdk_webclient`\n\nFace recognition as easy as reading two bytes.\n\nIf you have any problems with or questions about this client, please contact us\nthrough a [GitHub issue](https://github.com/regulaforensics/FaceSDK-web-python-client/issues).\nYou 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; \nWe are always thrilled to receive pull requests, and do our best to process them as fast as we can.\nSee [dev guide](./dev.md)\n\n## Install package\n`regula_facesdk_webclient` is on the Python Package Index (PyPI):\n\n```bash\npip install regula_facesdk_webclient\n```\n\nOr using `pipenv`\n```bash\npipenv install regula_facesdk_webclient\n```\n\n## Example\nPerforming request:\n\n```python\nfrom regula.facesdk.webclient import MatchImage, MatchRequest\nfrom regula.facesdk.webclient.ext import FaceSdk, DetectRequest\nfrom regula.facesdk.webclient.gen.model.image_source import ImageSource\n\nwith open(\"face1.jpg\", \"rb\") as f:\n    face_1_bytes = f.read()\n\nwith open(\"face2.jpg\", \"rb\") as f:\n    face_2_bytes = f.read()\n\nwith FaceSdk(host=\"http://0.0.0.0:41101\") as sdk:\n    images = [\n        MatchImage(index=1, data=face_1_bytes, type=ImageSource.LIVE),\n        MatchImage(index=2, data=face_1_bytes, type=ImageSource.DOCUMENT_RFID),\n        MatchImage(index=3, data=face_2_bytes)\n    ]\n    match_request = MatchRequest(images=images, thumbnails=True)\n    match_response = sdk.match_api.match(match_request)\n\n    detect_request = DetectRequest(image=face_1_bytes)\n    detect_response = sdk.match_api.detect(detect_request)\n```\n\nYou can find more detailed guide and run this sample in [example](./example) folder.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Regula's FaceSDK web python client",
    "version": "7.1.318",
    "project_urls": {
        "Homepage": "https://regulaforensics.com"
    },
    "split_keywords": [
        "face recognition",
        " facesdk",
        " regulaforensics",
        " regula"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7821a81a966c780bc7fa79a36dcde3304dd851d7f0193cfefa20458770724708",
                "md5": "899e19fdbb87e73756bbfc5d0e36f8e5",
                "sha256": "88d5590d8044cecd2e3940061eeee7a3bab8048fdf0314a5b25541ca2ae3cfc7"
            },
            "downloads": -1,
            "filename": "regula_facesdk_webclient-7.1.318-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "899e19fdbb87e73756bbfc5d0e36f8e5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 268245,
            "upload_time": "2025-07-09T08:29:17",
            "upload_time_iso_8601": "2025-07-09T08:29:17.428844Z",
            "url": "https://files.pythonhosted.org/packages/78/21/a81a966c780bc7fa79a36dcde3304dd851d7f0193cfefa20458770724708/regula_facesdk_webclient-7.1.318-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "29e965c5ce587e53616b0a1113e5e4ee1fec3be110e125ee83d559e98edc20e3",
                "md5": "2c9d528fc55d2930d6cc1e889f46eb73",
                "sha256": "008e2b10c6eb3aa8191096d776cdaff70af7c637a541960f9cbc9d16a4ff35e3"
            },
            "downloads": -1,
            "filename": "regula_facesdk_webclient-7.1.318.tar.gz",
            "has_sig": false,
            "md5_digest": "2c9d528fc55d2930d6cc1e889f46eb73",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 92941,
            "upload_time": "2025-07-09T08:29:18",
            "upload_time_iso_8601": "2025-07-09T08:29:18.819699Z",
            "url": "https://files.pythonhosted.org/packages/29/e9/65c5ce587e53616b0a1113e5e4ee1fec3be110e125ee83d559e98edc20e3/regula_facesdk_webclient-7.1.318.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-09 08:29:18",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "regula-facesdk-webclient"
}
Regula Forensics, Inc.
Elapsed time: 0.59499s