Skip to main content

Python SDK for the Reeve API - A facial recognition service for person identification and verification

Project description

Project generated with PyScaffold

reeve_python_sdk

Python SDK for the Reeve API - A facial recognition service for person identification and verification.

This SDK provides a Python interface to interact with the Reeve API, enabling facial recognition capabilities including person management, face enrollment, face recognition, and face verification.

Features

  • Authentication - Token-based authentication with Bearer JWT

  • Person Management - Create, list, update, and delete persons

  • Face Management - Add, list, and delete face images for persons

  • Face Recognition - Identify unknown faces against enrolled persons

  • Face Verification - Verify faces against specific persons or compare two faces

Installation

pip install reeve_python_sdk

Development Installation

git clone https://github.com/qbit-codes/reeve-python-sdk.git
cd reeve-python-sdk
pip install -e .

Quick Start

import asyncio
from reeve_python_sdk import ReeveClient

async def main():
    async with ReeveClient(
        api_url="https://api.reeve.example.com",
        api_key="your-api-key"
    ) as client:
        # Create a person
        person = await client.person.add(firstname="John", lastname="Doe")
        person_id = person["result"]["id"]

        # Add a face to the person
        with open("face.jpg", "rb") as f:
            await client.face.add(person_id=person_id, face=f)

        # Recognize a face
        with open("unknown_face.jpg", "rb") as f:
            result = await client.face.recognize(face=f)
            if result.get("result"):
                print(f"Recognized: {result['result']['name']}")

asyncio.run(main())

API Documentation

Full API specification is available in docs/swagger.json.

Testing

Run tests with:

pytest

Or with tox for comprehensive testing:

tox

Note

This project has been set up using PyScaffold 4.6. For details and usage information on PyScaffold see https://pyscaffold.org/.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reeve_python_sdk-0.1.0.tar.gz (28.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reeve_python_sdk-0.1.0-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file reeve_python_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: reeve_python_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 28.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for reeve_python_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a8790e8741832dc09915168b3a802d476c5b20ef9e601e8ca1129f72efababdb
MD5 4a7055c729ab935b8332b22e50300212
BLAKE2b-256 aa3c4bde166c68b822f0e775745325572f30ac5b437c5939e118aeb1ba29ed4f

See more details on using hashes here.

File details

Details for the file reeve_python_sdk-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for reeve_python_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2f9d7d2866038ccf5665dd702554cb188bd06be572765412dd66b42383ec4804
MD5 9888b7fb6157ab7c045e19062a85a30c
BLAKE2b-256 cb23fc26e923ce4aed6666023ca5b99024ff8b4a90d2df18797abb7dc45a2f93

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page