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 - Username/password login, user registration, password management, and Bearer JWT support
• Person Management - Create, list, update, and delete persons
• Face Management - Add, list, and delete face images for persons
• Face Recognition - Identify unknown faces with confidence scores and face attributes
• Face Verification - Verify faces against specific persons or compare two faces
• Rich Data Models - Strongly-typed models for all API responses including face attributes

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

Authentication Methods

The SDK supports two authentication methods:

Method 1: Username/Password (Recommended)

import asyncio
from reeve_python_sdk import ReeveClient

async def main():
    # Auto-login with username and password
    async with ReeveClient(
        api_url="https://api.reeve.example.com",
        username="your-username",
        password="your-password"
    ) 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())

Method 2: Direct API Key

import asyncio
from reeve_python_sdk import ReeveClient

async def main():
    # Use existing JWT token
    async with ReeveClient(
        api_url="https://api.reeve.example.com",
        api_key="your-jwt-token"
    ) as client:
        persons = await client.person.list()
        print(persons)

asyncio.run(main())

Advanced Usage

Manual Login

async with ReeveClient(api_url="https://api.reeve.example.com") as client:
    # Login manually
    login_response = await client.auth.login(
        username="admin",
        password="password123"
    )
    print(f"Token: {login_response.token}")
    print(f"Expires: {login_response.expires_at}")

User Registration (Admin only)

async with ReeveClient(
    api_url="https://api.reeve.example.com",
    api_key="admin-token"
) as client:
    response = await client.auth.register(
        username="newuser",
        email="user@example.com",
        password="secure-password",
        role="User"
    )
    print(response.message)

Change Password

async with ReeveClient(
    api_url="https://api.reeve.example.com",
    api_key="user-token"
) as client:
    response = await client.auth.change_password(
        current_password="old-password",
        new_password="new-password"
    )
    print(response.message)

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/.