noonlight-dispatch 0.1.2

Async client for the Noonlight Dispatch API

noonlight-dispatch

A small, typed, async Python client for the Noonlight Dispatch API (/dispatch/v1). Built on httpx, it accepts a shared client/session so it slots cleanly into apps like Home Assistant.

It handles the Noonlight wire-format quirks for you: phone numbers are sent as digits with a country code but no leading +, and US states as the uppercase 2-letter code.

Install

pip install noonlight-dispatch

Usage

import httpx
from noonlight_dispatch import NoonlightClient, SANDBOX_BASE_URL

async def main():
    async with httpx.AsyncClient() as session:
        client = NoonlightClient(session, "YOUR_TOKEN", base_url=SANDBOX_BASE_URL)

        alarm = await client.create_alarm(
            services=["police"],
            name="Jane Doe",
            phone="[phone]",   # stored/sent as 12025550142
            address="123 Main St",
            city="Springfield",
            state="va",                  # sent as VA
            zip_code="62704",
            instructions="Triggered by Front Door motion",  # -> instructions.entry
            owner_id="Site A",           # caller-defined site identifier
        )
        alarm_id = alarm["id"]

        status = await client.get_alarm_status(alarm_id)
        await client.cancel_alarm(alarm_id)

SANDBOX_BASE_URL never alerts real responders — use it for testing. PRODUCTION_BASE_URL is the default.

Errors

All failures raise a subclass of NoonlightError:

• NoonlightAuthError — token rejected (401/403)
• NoonlightConnectionError — unreachable / timeout
• NoonlightResponseError — unexpected status or body (carries .status_code)

Development

pip install -e ".[test]"
pytest

License

MIT