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

This repository currently focuses on the CAD v2 API surface 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",
            }
        ],
    }
)

Notes

  • Only CAD v2 helpers are included right now.
  • Helper names match Sonoran.js.
  • 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.6.tar.gz (10.4 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.6-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sonoran_py-0.1.6.tar.gz
  • Upload date:
  • Size: 10.4 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.6.tar.gz
Algorithm Hash digest
SHA256 275a6d9eb41dd9db55e3fd43daaca3ab6812ca74b1544609764ac81966bb25a6
MD5 4e7ab1dd02c56ef5838bfca531615f3c
BLAKE2b-256 f7f274b8c4288a0682a91a8d6dce2537d9b6339c7b75cda0252b9d26a3df80f2

See more details on using hashes here.

Provenance

The following attestation bundles were made for sonoran_py-0.1.6.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.6-py3-none-any.whl.

File metadata

  • Download URL: sonoran_py-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 11.7 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 8e64f686b837d3d7944f68c34cdfebfc20d3bd9135f539bd393e53f2f3048ee0
MD5 e2def41e9412a2a9670494a0ac4b9821
BLAKE2b-256 3398e5c1f8ee3e3120725edecc26ecac4e697a9ab7dc38a1b3ef3f22b5eaf3fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for sonoran_py-0.1.6-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