Skip to main content

Python SDK for Sonoran CAD and CMS integrations

Project description

Sonoran.py

Sonoran.py is the Python library for Sonoran CAD and Radio integrations.

This repository currently focuses on the CAD and Radio v2 API surfaces and mirrors the public helper names from Sonoran.js.

Install

pip install Sonoran.py

Example Usage

from sonoran import Instance, productEnums

instance = Instance(
    apiKey="YOUR_API_KEY",
    communityId="YOUR_COMMUNITY_ID",
    product=productEnums.CAD,
    serverId=1,
)

response = instance.cad.createEmergencyCallV2(
    {
        "serverId": 1,
        "isEmergency": True,
        "caller": "John Doe",
        "location": "101 Alta Street",
        "description": "Structure fire with visible smoke.",
        "deleteAfterMinutes": 30,
    }
)

if response.success:
    print(response.data)
else:
    print(response.reason)
location_response = instance.cad.updateUnitLocationsV2(
    {
        "serverId": 1,
        "updates": [
            {
                "roblox": 123456789,
                "location": "Mission Row",
            }
        ],
    }
)
with open("bodycam-clip.webm", "rb") as clip:
    bodycam_response = instance.cad.uploadBodycamRecordingV2(
        {
            "accountUuid": "USER_ACCOUNT_UUID",
            "durationMs": 90000,
            "identId": 123,
            "unitNumber": "1A-12",
            "unitLocation": "Senora Fwy / Route 68",
            "fileName": "bodycam-clip.webm",
            "fileContent": clip.read(),
            "contentType": "video/webm",
        }
    )

Notes

  • CAD and Radio v2 helpers are included right now.
  • Helper names match Sonoran.js.
  • Radio v2 clients use communityId for /v2/servers/{communityId} routes and roomId on client creation for room-scoped helpers:
radio = Instance(
    apiKey="YOUR_RADIO_API_KEY",
    communityId="YOUR_COMMUNITY_ID",
    product=productEnums.RADIO,
    roomId=2,
)

radio.setRoomId(1)
  • instance.cad.setStationsV2(...) sends locations, tones, and unitColors at the top level of the request body.
  • Bodycam uploads use instance.cad.uploadBodycamRecordingV2(...) with multipart form data built by the SDK.
  • CAD v2 requests automatically retry 429 responses up to 2 times and respect Retry-After when it is provided.
  • The import package remains sonoran.

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

sonoran_py-0.1.14.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

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

sonoran_py-0.1.14-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file sonoran_py-0.1.14.tar.gz.

File metadata

  • Download URL: sonoran_py-0.1.14.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sonoran_py-0.1.14.tar.gz
Algorithm Hash digest
SHA256 77e34406c1b10b3f400ff1368edcecf250402ffeb39078b08e3304227cb1109a
MD5 690ffb06ff4a71a8f7c2f05abb01e2e6
BLAKE2b-256 f46d84ce98d729c09f1eb653b8f594b4e3f0c8d093253527a76945916f557a33

See more details on using hashes here.

Provenance

The following attestation bundles were made for sonoran_py-0.1.14.tar.gz:

Publisher: release.yml on Sonoran-Software/Sonoran.py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sonoran_py-0.1.14-py3-none-any.whl.

File metadata

  • Download URL: sonoran_py-0.1.14-py3-none-any.whl
  • Upload date:
  • Size: 12.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sonoran_py-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 ca811753c79f3dfe9584d2a00ee77988971b746d949e2213bf4fac21792937bb
MD5 9e91e6d5327686ddbcc9bbb76882e190
BLAKE2b-256 f07ba7f70bd817e9f51192209bad42dcd96630880f5e5434237846b0a5b7432d

See more details on using hashes here.

Provenance

The following attestation bundles were made for sonoran_py-0.1.14-py3-none-any.whl:

Publisher: release.yml on Sonoran-Software/Sonoran.py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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