# Regula Face SDK web API Python 3.5+ client
[](https://github.com/regulaforensics/FaceSDK-web-openapi)
[](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
[](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://mobile.regulaforensics.com",
"name": "regula.facesdk.webclient",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "face recognition,facesdk,regulaforensics,regula",
"author": "Regula Forensics, Inc.",
"author_email": "support@regulaforensics.com",
"download_url": "https://files.pythonhosted.org/packages/c7/c0/6e6e361aab633f9cc5ed5dda370f6e3dc8df1c0481971a301d329dd37e0d/regula.facesdk.webclient-6.1.0.tar.gz",
"platform": null,
"description": "# Regula Face SDK web API Python 3.5+ client\n\n[](https://github.com/regulaforensics/FaceSDK-web-openapi)\n[](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)\n[](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": "",
"summary": "Regula's FaceSDK web python client",
"version": "6.1.0",
"project_urls": {
"Homepage": "https://mobile.regulaforensics.com"
},
"split_keywords": [
"face recognition",
"facesdk",
"regulaforensics",
"regula"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c135b04e30164b0ada28337c220303076ecdcc0ce32430a651aa86bc54e9cedc",
"md5": "f13d16e7e7fae540227e4e20521d335b",
"sha256": "87eaabd7899c357f3cf5c3a5475c8b01771b051d47d827d4c41d78d2cac866e5"
},
"downloads": -1,
"filename": "regula.facesdk.webclient-6.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f13d16e7e7fae540227e4e20521d335b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 221076,
"upload_time": "2024-02-21T16:16:56",
"upload_time_iso_8601": "2024-02-21T16:16:56.882836Z",
"url": "https://files.pythonhosted.org/packages/c1/35/b04e30164b0ada28337c220303076ecdcc0ce32430a651aa86bc54e9cedc/regula.facesdk.webclient-6.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c7c06e6e361aab633f9cc5ed5dda370f6e3dc8df1c0481971a301d329dd37e0d",
"md5": "381afedfd94388548f2e2639209e391d",
"sha256": "7033aeb4135813a7319648f735beca298fb0586f58482dcebfbe426ac7017653"
},
"downloads": -1,
"filename": "regula.facesdk.webclient-6.1.0.tar.gz",
"has_sig": false,
"md5_digest": "381afedfd94388548f2e2639209e391d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 84098,
"upload_time": "2024-02-21T16:16:58",
"upload_time_iso_8601": "2024-02-21T16:16:58.228835Z",
"url": "https://files.pythonhosted.org/packages/c7/c0/6e6e361aab633f9cc5ed5dda370f6e3dc8df1c0481971a301d329dd37e0d/regula.facesdk.webclient-6.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-21 16:16:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "regula.facesdk.webclient"
}
JSON