regula.facesdk.webclient


Nameregula.facesdk.webclient JSON
Version 6.4.107 PyPI version JSON
download
home_pagehttps://regulaforensics.com
SummaryRegula's FaceSDK web python client
upload_time2024-12-09 10:42:15
maintainerNone
docs_urlNone
authorRegula Forensics, Inc.
requires_python>=3.5
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.5+ 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/)

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 *

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 MatchingApi(host="http://0.0.0.0:41101/api") as api:
    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 = api.match(match_request)

    detect_request = DetectRequest(face_1_bytes)
    detect_response = 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.5",
    "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/f4/94/cc0dafdb4ce9b90ed7fe76ae0b1d807cfd5396586c7228f4f3e25155c5b3/regula_facesdk_webclient-6.4.107.tar.gz",
    "platform": null,
    "description": "# Regula Face SDK web API Python 3.5+ 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\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 *\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 MatchingApi(host=\"http://0.0.0.0:41101/api\") as api:\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)\n    match_response = api.match(match_request)\n\n    detect_request = DetectRequest(face_1_bytes)\n    detect_response = 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": "6.4.107",
    "project_urls": {
        "Homepage": "https://regulaforensics.com"
    },
    "split_keywords": [
        "face recognition",
        " facesdk",
        " regulaforensics",
        " regula"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "acce56a3b9bd9bf640405ca45bfd8faa3d7c7d76424c8191c920feadad8f6d52",
                "md5": "71753d24ded197af1d55f642f46af1a0",
                "sha256": "02a1958af7f8e67b70c8f086108de42e70e34936ba637aee0ceffc3416303e04"
            },
            "downloads": -1,
            "filename": "regula.facesdk.webclient-6.4.107-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "71753d24ded197af1d55f642f46af1a0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5",
            "size": 263425,
            "upload_time": "2024-12-09T10:42:13",
            "upload_time_iso_8601": "2024-12-09T10:42:13.534527Z",
            "url": "https://files.pythonhosted.org/packages/ac/ce/56a3b9bd9bf640405ca45bfd8faa3d7c7d76424c8191c920feadad8f6d52/regula.facesdk.webclient-6.4.107-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f494cc0dafdb4ce9b90ed7fe76ae0b1d807cfd5396586c7228f4f3e25155c5b3",
                "md5": "90a515ac4d2bb0149df6058aec78d870",
                "sha256": "bd43009de155e787bf0d3aa8feb9efdf661bb7e33ae2e05964e3fb07cdb80719"
            },
            "downloads": -1,
            "filename": "regula_facesdk_webclient-6.4.107.tar.gz",
            "has_sig": false,
            "md5_digest": "90a515ac4d2bb0149df6058aec78d870",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 91483,
            "upload_time": "2024-12-09T10:42:15",
            "upload_time_iso_8601": "2024-12-09T10:42:15.825463Z",
            "url": "https://files.pythonhosted.org/packages/f4/94/cc0dafdb4ce9b90ed7fe76ae0b1d807cfd5396586c7228f4f3e25155c5b3/regula_facesdk_webclient-6.4.107.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-09 10:42:15",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "regula.facesdk.webclient"
}
Regula Forensics, Inc.
Elapsed time: 0.48807s