Skip to main content

Official Python client for the StormwaterIQ external API (typed client, webhook signature verifier, retry helpers).

Project description

stormwateriq-api-client

Official Python client for the StormwaterIQ external API: a typed-ish client, the reference webhook-signature verifier, and automatic retries.

pip install stormwateriq-api-client
from stormwateriq_api_client import StormwaterIQClient, verify

with StormwaterIQClient("https://api.stormwateriq.com", access_token) as client:
    site = client.get_site("site_123")

# Verify an inbound webhook (constant-time, replay-protected):
ok = verify(raw_body, request.headers["X-StormwaterIQ-Signature"], signing_secret)
  • Retries — requests retry 429 (honoring Retry-After) and 5xx with exponential backoff (max_retries, default 3); other 4xx raise ApiError.
  • Webhook verifierverify(payload, signature, secret) is stdlib-only (hmac/hashlib) and byte-identical to the server and the TypeScript SDK, pinned to fixtures/webhook-signature-vectors.json. Importing the verifier never requires httpx (the client is lazily imported).

Generation

Models track the gateway's OpenAPI document (https://api.stormwateriq.com/v1/openapi.json); regenerate with openapi-python-client when the spec changes. Published independently of the API (semver).

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

stormwateriq_api_client-0.1.1.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

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

stormwateriq_api_client-0.1.1-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file stormwateriq_api_client-0.1.1.tar.gz.

File metadata

  • Download URL: stormwateriq_api_client-0.1.1.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for stormwateriq_api_client-0.1.1.tar.gz
Algorithm Hash digest
SHA256 f255d9679fd2c72faca512e551e8dbfdfc20ca596621b75db81084b20111de69
MD5 4afd55467c110d78750464a1b7be4091
BLAKE2b-256 0f0fdde6fe65a3d674514c83625f3d94097a6286f43113b2b5915b8b6367a5cc

See more details on using hashes here.

File details

Details for the file stormwateriq_api_client-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: stormwateriq_api_client-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for stormwateriq_api_client-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a306d80bd631b7d64c5158f22bc2c152c0f2594788f8a0e0cfa1618734b9085f
MD5 7f61d6368576e4959d41c8cfd08062bb
BLAKE2b-256 d68bdf31fd90e19782321eccd417a32a80067930a550c262bfb84dc777568468

See more details on using hashes here.

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