Metadata-Version: 2.4
Name: perceptryx-sdk
Version: 0.1.0
Summary: Python SDK for the Perceptryx recognition system
Author: Antonio
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: requests>=2.31
Provides-Extra: history
Requires-Dist: openpyxl>=3.1; extra == "history"

# Perceptryx SDK

Python SDK for interacting with a running Perceptryx recognition server.

## Installation

```bash
pip install perceptryx-sdk
````

For recognition history support:

```bash
pip install "perceptryx-sdk[history]"
```

## Quick Start

```python
from perceptryx import Perceptryx

px = Perceptryx("http://localhost:5000")

people = px.people.list()

for person in people:
    print(person.name)
```

## Enroll a Person

```python
person = px.people.add("Marko", "marko.jpg")

print(person.id)
print(person.name)
```

## Live Recognition

```python
for event in px.recognition.stream():
    if event.known:
        print(f"Welcome, {event.name}!")
    else:
        print("Unknown visitor")
```

## System Health

```python
status = px.health.status()

print(status.is_healthy)
print(status.active_nodes)
print(status.active_devices)
```

## Devices

```python
devices = px.devices.list()

for device in devices:
    print(device.id, device.status)
```

## Requirements

* Python 3.9+
* A running Perceptryx recognition server
