<div align="left">
<h1>Search4FacesAPI <img src="https://search4faces.com/favicon.ico" width=30 height=30></h1>
<p align="left" >
<a href="https://pypi.org/project/Search4Faces/">
<img src="https://img.shields.io/pypi/v/Search4Faces?style=flat-square" alt="PyPI">
</a>
<a href="https://pypi.org/project/Search4Faces/">
<img src="https://img.shields.io/pypi/dd/Search4Faces?style=flat-square" alt="PyPI">
</a>
</p>
</div>
A simple library with async capabilities to interact with Search4Faces [API](https://search4faces.com/api.html)
## Usage
With ``SearchClient`` you can easily find social media profiles with similar faces. It is a great tool for finding duplicates, finding people, and more.
## Documentation
Official docs can be found on the [API's webpage](https://search4faces.com/api.html)
## Installation
```bash
pip install Search4Faces
```
## Requirements
- ``Python 3.9+``
- ``httpx``
- ``pydantic``
## Features
- ``Async capabilities``
- ``Exception handling``
- ``Pydantic return model``
- ``LightWeight``
## Examples
```python
from Search4Faces import (
SearchClient,
SearchAPIError,
MatchedPerson,
sources,
)
client = SearchClient(
token='your-token',
no_check=False, # if you want to disable token check
)
# you can use photo's url - client will fetch the image for you
photo_url = 'https://imgur.com/XYZ.jpg'
response: list[MatchedPerson] = client.find_similar(
photo_url,
source=sources.VK_OK_NEW_AVATAR, # you can specify the image database to search in
show_hidden=True, # or define if you want hidden profiles to show up
results=25, # and choose how many results you want back (max 500)
)
# you can also provide a file / io.BytesIO object
response: list[MatchedPerson] = client.find_similar(
open('photo.jpg', 'rb'),
)
# you can do some exception handling
try:
response: list[MatchedPerson] = client.find_similar(photo_url)
except SearchAPIError as exc:
print(exc)
# you can use some async methods
await client.find_similar_async(photo_url)
```
Developed by Nikita Minaev (c) 2023
Raw data
{
"_id": null,
"home_page": "https://github.com/nikitalm8/Search4FacesAPI",
"name": "Search4Faces",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,face recognition,search4faces,ai",
"author": "Nikita Minaev",
"author_email": "<nikita@minaev.su>",
"download_url": "https://files.pythonhosted.org/packages/f5/9c/b25a9b49fd3aa8263c3b949db3206d0df3b1d9c3cb8eaf1afbc61203894b/Search4Faces-1.0.2.tar.gz",
"platform": null,
"description": "\n<div align=\"left\">\n <h1>Search4FacesAPI <img src=\"https://search4faces.com/favicon.ico\" width=30 height=30></h1>\n <p align=\"left\" >\n <a href=\"https://pypi.org/project/Search4Faces/\">\n <img src=\"https://img.shields.io/pypi/v/Search4Faces?style=flat-square\" alt=\"PyPI\">\n </a>\n <a href=\"https://pypi.org/project/Search4Faces/\">\n <img src=\"https://img.shields.io/pypi/dd/Search4Faces?style=flat-square\" alt=\"PyPI\">\n </a>\n </p>\n</div>\n\nA simple library with async capabilities to interact with Search4Faces [API](https://search4faces.com/api.html)\n\n\n## Usage\n\nWith ``SearchClient`` you can easily find social media profiles with similar faces. It is a great tool for finding duplicates, finding people, and more.\n\n## Documentation\n\nOfficial docs can be found on the [API's webpage](https://search4faces.com/api.html)\n\n## Installation\n\n```bash\npip install Search4Faces\n```\n\n## Requirements\n\n - ``Python 3.9+``\n - ``httpx``\n - ``pydantic``\n\n## Features\n\n - ``Async capabilities``\n - ``Exception handling``\n - ``Pydantic return model``\n - ``LightWeight``\n\n## Examples\n\n```python\nfrom Search4Faces import (\n SearchClient, \n SearchAPIError, \n MatchedPerson,\n sources,\n)\n\nclient = SearchClient(\n token='your-token', \n no_check=False, # if you want to disable token check\n) \n\n# you can use photo's url - client will fetch the image for you\nphoto_url = 'https://imgur.com/XYZ.jpg'\nresponse: list[MatchedPerson] = client.find_similar(\n photo_url,\n source=sources.VK_OK_NEW_AVATAR, # you can specify the image database to search in\n show_hidden=True, # or define if you want hidden profiles to show up\n results=25, # and choose how many results you want back (max 500)\n)\n\n# you can also provide a file / io.BytesIO object\nresponse: list[MatchedPerson] = client.find_similar(\n open('photo.jpg', 'rb'),\n)\n\n# you can do some exception handling\ntry:\n\n response: list[MatchedPerson] = client.find_similar(photo_url)\n\nexcept SearchAPIError as exc:\n\n print(exc)\n\n# you can use some async methods\nawait client.find_similar_async(photo_url)\n```\n\nDeveloped by Nikita Minaev (c) 2023\n",
"bugtrack_url": null,
"license": "",
"summary": "Face recognition via Search4Faces API",
"version": "1.0.2",
"split_keywords": [
"python",
"face recognition",
"search4faces",
"ai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "92f0a10bdfa1d4c912d0dfc991f0ba52a010953e388afbf9752237791edfc74b",
"md5": "cd9373fc3cdbb28246f917534ae12956",
"sha256": "5799e5cf2c2c3966bc996587cdff8e4519b66b2bed953de0499f0f25de7fd59c"
},
"downloads": -1,
"filename": "Search4Faces-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd9373fc3cdbb28246f917534ae12956",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5987,
"upload_time": "2023-01-06T12:21:44",
"upload_time_iso_8601": "2023-01-06T12:21:44.400842Z",
"url": "https://files.pythonhosted.org/packages/92/f0/a10bdfa1d4c912d0dfc991f0ba52a010953e388afbf9752237791edfc74b/Search4Faces-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f59cb25a9b49fd3aa8263c3b949db3206d0df3b1d9c3cb8eaf1afbc61203894b",
"md5": "b24516ae53dcf6d292eb10eb30966f80",
"sha256": "f0db181554b27b0d434657c0f6dac48b2a3f9bf9ebbe56bcad721e7189f81b59"
},
"downloads": -1,
"filename": "Search4Faces-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "b24516ae53dcf6d292eb10eb30966f80",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5013,
"upload_time": "2023-01-06T12:21:46",
"upload_time_iso_8601": "2023-01-06T12:21:46.033169Z",
"url": "https://files.pythonhosted.org/packages/f5/9c/b25a9b49fd3aa8263c3b949db3206d0df3b1d9c3cb8eaf1afbc61203894b/Search4Faces-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-06 12:21:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "nikitalm8",
"github_project": "Search4FacesAPI",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "search4faces"
}
JSON
