Skip to main content

A package for imou open api

Project description

pyimouapi

Async Python client for the Imou Open Platform cloud APIs. Built on aiohttp, it handles authentication and requests, and exposes device/channel helpers plus higher-level types for integrations (for example Home Assistant).

Package layout

Module Role
pyimouapi.openapi ImouOpenApiClient — auth, signing, token lifecycle, HTTP calls
pyimouapi.device ImouDeviceManager, ImouDevice, ImouChannel — listing, PTZ, alarms, storage, and related endpoints
pyimouapi.ha_device ImouHaDeviceManager, ImouHaDevice, … — aggregated “device model” helpers for automation stacks
pyimouapi.exceptions ImouException and typed errors (connect, request, invalid credentials, …)

The top-level pyimouapi package re-exports common symbols. Import submodules directly when needed, for example from pyimouapi.ha_device import ImouHaDeviceManager.

Dependencies

As declared in setup.py / requirements.txt:

  • aiohttp>=3.11.9,<4.0
  • simpleeval>=1.0.3

Install

pip install pyimouapi

From a checkout:

pip install .

Quick example (async)

from pyimouapi.openapi import ImouOpenApiClient

# host: Imou Open Platform gateway, e.g. openapi-sg.easy4ip.com
client = ImouOpenApiClient("your_app_id", "your_app_secret", "openapi-sg.easy4ip.com")
await client.async_get_token()
# Use the client with pyimouapi.device.ImouDeviceManager for device operations

License

MIT — see LICENSE in this repository.

Project details


Release history Release notifications | RSS feed

This version

1.3.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyimouapi-1.3.0.tar.gz (25.5 kB view details)

Uploaded Source

Built Distribution

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

pyimouapi-1.3.0-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

Details for the file pyimouapi-1.3.0.tar.gz.

File metadata

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

File hashes

Hashes for pyimouapi-1.3.0.tar.gz
Algorithm Hash digest
SHA256 808f8d7335ff1c31c3622e1f2467263c918822c9902365220359a92e1a1910c2
MD5 c7c2931853b631fe998cf0c72f57766d
BLAKE2b-256 de390df6caa4aaddff65b443e5b67d793878f175d226af80e209d53cfac72fb1

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyimouapi-1.3.0.tar.gz:

Publisher: publish.yml on Imou-OpenPlatform/Py-Imou-Open-Api

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

File details

Details for the file pyimouapi-1.3.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for pyimouapi-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e21782bb0f249404d512487081fb320a2c5d1f8e665739dd68e373369ab22539
MD5 fb1e20bd9ed4e6b70b4106dca143c12c
BLAKE2b-256 9fa6cf973e7bb565c614c0f8b3112a1336bd7d4ae69a33b573907dcbbcafc373

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyimouapi-1.3.0-py3-none-any.whl:

Publisher: publish.yml on Imou-OpenPlatform/Py-Imou-Open-Api

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