PraxisEdge LPR
Sign in
Preview SDK · install from source

Python SDK reference

The `atclpr` Python package source is in `sdk/python` and exposes async REST, WebSocket streaming, events, and optional MQTT helpers. It is not published to PyPI yet.

Install

Source install only until a PyPI package is published.

# Preview: not published to PyPI yet; install from source.
pip install "git+<repo-url>#subdirectory=sdk/python"  # preview: install from source, not PyPI

Minimal read

Import `ApiClient` from the real top-level package export.

import asyncio
import os
from pathlib import Path

from atclpr import ApiClient


async def main() -> None:
    async with ApiClient(
        base_url="https://praxisedge.ai",
        api_key=os.environ["PRAXISEDGE_API_KEY"],
    ) as api:
        reply = await api.read(Path("plate.jpg").read_bytes())
        print(reply.plate, reply.decision, reply.request_id)


asyncio.run(main())

Public imports

Names exported by `atclpr.__init__` and `atclpr.api`.

from atclpr import

ApiClientStreamClientEventsClientMqttClientReadReplyReadResponseBatchReplyDetectResponseMqttReplyAtcLprErrorApiErrorStreamErrorReadErrorEventsErrorLostInferenceError

from atclpr.api import

ApiClientBatchItemBatchReplyDetectResponseDetectionHealthResponseReadResponseUsageDaily

ApiClient surface

Current async methods from `sdk/python/src/atclpr/api/client.py`.

read(image)

Calls `/v1/read` for one plate crop and returns `ReadResponse`.

read_batch(items)

Calls `/v1/read-batch` with bytes or `BatchItem` values.

detect(image)

Calls `/v1/detect` when a detector origin is available.

health()

Reads `/v1/health` and returns `HealthResponse`.

usage_daily(start, end)

Reads billing rollups when the deployment exposes usage endpoints.

iter_read(images)

Async generator for concurrent REST reads over an image iterable.

Start with the raw API contract

The quickstart shows the underlying `/v1/read` request before you add the preview SDK.

QuickstartAPI reference