pyimouapi 1.2.6__tar.gz → 1.2.8__tar.gz

pyimouapi-1.2.8/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: pyimouapi
+Version: 1.2.8
+Summary: A package for imou open api
+Home-page: https://github.com/Imou-OpenPlatform/Py-Imou-Open-Api
+Author: Imou-OpenPlatform
+Author-email: Imou-OpenPlatform <cloud_openteam_service@imou.com>
+License: MIT
+Project-URL: Homepage, https://github.com/Imou-OpenPlatform/Py-Imou-Open-Api
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp<4.0,>=3.11.9
+Requires-Dist: simpleeval>=1.0.3
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# 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).
+
+- **Repository:** [Imou-OpenPlatform/Py-Imou-Open-Api](https://github.com/Imou-OpenPlatform/Py-Imou-Open-Api)
+- **Version:** Same as `setup.py` / PyPI (`pyimouapi.__version__`)
+- **Python:** `>= 3.11`
+
+## 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
+
+```bash
+pip install pyimouapi
+```
+
+From a checkout:
+
+```bash
+pip install .
+```
+
+## Quick example (async)
+
+```python
+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.

pyimouapi-1.2.8/README.md

@@ -0,0 +1,52 @@
+# 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).
+
+- **Repository:** [Imou-OpenPlatform/Py-Imou-Open-Api](https://github.com/Imou-OpenPlatform/Py-Imou-Open-Api)
+- **Version:** Same as `setup.py` / PyPI (`pyimouapi.__version__`)
+- **Python:** `>= 3.11`
+
+## 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
+
+```bash
+pip install pyimouapi
+```
+
+From a checkout:
+
+```bash
+pip install .
+```
+
+## Quick example (async)
+
+```python
+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.

pyimouapi-1.2.8/pyimouapi/__init__.py

@@ -0,0 +1,20 @@
+__version__ = "1.2.8"
+
+from .device import ImouChannel, ImouDevice, ImouDeviceManager
+from .exceptions import (
+    ConnectFailedException,
+    InvalidAppIdOrSecretException,
+    RequestFailedException,
+)
+from .openapi import ImouOpenApiClient
+
+__all__ = [
+    "ConnectFailedException",
+    "ImouChannel",
+    "ImouDevice",
+    "ImouDeviceManager",
+    "ImouOpenApiClient",
+    "InvalidAppIdOrSecretException",
+    "RequestFailedException",
+    "__version__",
+]

{pyimouapi-1.2.6 → pyimouapi-1.2.8}/pyimouapi/const.py

@@ -518,5 +518,5 @@ NIGHT_VISION_MODE_MAP = {
     "infrared": "Infrared",
     "off": "Off",
     "lowlight": "LowLight",
-    "smartlowlight": "SmartLowLight"
+    "smartlowlight": "SmartLowLight",
 }

{pyimouapi-1.2.6 → pyimouapi-1.2.8}/pyimouapi/device.py

@@ -3,63 +3,63 @@ from __future__ import annotations
 from typing import Any
 
 from .const import (
-    API_ENDPOINT_LIST_DEVICE_DETAILS,
-    PARAM_PAGE_SIZE,
-    PARAM_PAGE,
-    PARAM_DEVICE_ID,
-    PARAM_CHANNEL_ID,
+    API_ENDPOINT_BIND_DEVICE_LIVE,
     API_ENDPOINT_CONTROL_DEVICE_PTZ,
-    API_ENDPOINT_MODIFY_DEVICE_ALARM_STATUS,
-    API_ENDPOINT_GET_DEVICE_STATUS,
-    API_ENDPOINT_SET_DEVICE_STATUS,
-    API_ENDPOINT_GET_DEVICE_NIGHT_VISION_MODE,
+    API_ENDPOINT_DEVICE_SD_CARD_STATUS,
     API_ENDPOINT_DEVICE_STORAGE,
-    API_ENDPOINT_RESTART_DEVICE,
-    API_ENDPOINT_BIND_DEVICE_LIVE,
-    API_ENDPOINT_GET_DEVICE_ONLINE,
+    API_ENDPOINT_GET_DEVICE_ALARM_PARAM,
     API_ENDPOINT_GET_DEVICE_LIVE_INFO,
+    API_ENDPOINT_GET_DEVICE_NIGHT_VISION_MODE,
+    API_ENDPOINT_GET_DEVICE_ONLINE,
+    API_ENDPOINT_GET_DEVICE_POWER_INFO,
+    API_ENDPOINT_GET_DEVICE_STATUS,
+    API_ENDPOINT_GET_IOT_DEVICE_DETAIL_INFO,
+    API_ENDPOINT_GET_IOT_DEVICE_PROPERTIES,
+    API_ENDPOINT_GET_PRODUCT_MODEL,
+    API_ENDPOINT_IOT_DEVICE_CONTROL,
+    API_ENDPOINT_LIST_DEVICE_DETAILS,
+    API_ENDPOINT_MODIFY_DEVICE_ALARM_STATUS,
+    API_ENDPOINT_RESTART_DEVICE,
+    API_ENDPOINT_SET_DEVICE_NIGHT_VISION_MODE,
     API_ENDPOINT_SET_DEVICE_SNAP,
-    PARAM_MODE,
-    PARAM_ENABLE_TYPE,
-    PARAM_ENABLE,
+    API_ENDPOINT_SET_DEVICE_STATUS,
+    API_ENDPOINT_SET_IOT_DEVICE_PROPERTIES,
+    API_ENDPOINT_WAKE_UP_DEVICE,
+    NIGHT_VISION_MODE_MAP,
+    PARAM_ABILITY_REFS,
+    PARAM_ACCESS_TYPE,
+    PARAM_BRAND,
+    PARAM_CHANNEL_ABILITY,
+    PARAM_CHANNEL_ID,
+    PARAM_CHANNEL_LIST,
+    PARAM_CHANNEL_NAME,
+    PARAM_CHANNEL_NUM,
+    PARAM_CHANNEL_STATUS,
+    PARAM_CHANNELS,
+    PARAM_CONTENT,
     PARAM_COUNT,
+    PARAM_DEVICE_ABILITY,
+    PARAM_DEVICE_ID,
     PARAM_DEVICE_LIST,
+    PARAM_DEVICE_MODEL,
     PARAM_DEVICE_NAME,
     PARAM_DEVICE_STATUS,
-    PARAM_DEVICE_ABILITY,
     PARAM_DEVICE_VERSION,
-    PARAM_BRAND,
-    PARAM_DEVICE_MODEL,
-    PARAM_CHANNEL_LIST,
-    PARAM_CHANNEL_NAME,
-    PARAM_CHANNEL_STATUS,
-    PARAM_CHANNEL_ABILITY,
-    PARAM_STREAM_ID,
-    PARAM_OPERATION,
     PARAM_DURATION,
-    API_ENDPOINT_GET_DEVICE_ALARM_PARAM,
-    API_ENDPOINT_SET_DEVICE_NIGHT_VISION_MODE,
+    PARAM_ENABLE,
+    PARAM_ENABLE_TYPE,
+    PARAM_MODE,
+    PARAM_MULTI_FLAG,
+    PARAM_OPERATION,
+    PARAM_PAGE,
+    PARAM_PAGE_SIZE,
+    PARAM_PARENT_DEVICE_ID,
+    PARAM_PARENT_PRODUCT_ID,
     PARAM_PRODUCT_ID,
     PARAM_PROPERTIES,
-    API_ENDPOINT_GET_IOT_DEVICE_PROPERTIES,
-    API_ENDPOINT_SET_IOT_DEVICE_PROPERTIES,
-    API_ENDPOINT_DEVICE_SD_CARD_STATUS,
-    PARAM_CHANNEL_NUM,
-    PARAM_PARENT_PRODUCT_ID,
-    PARAM_PARENT_DEVICE_ID,
     PARAM_REF,
-    PARAM_CONTENT,
-    API_ENDPOINT_IOT_DEVICE_CONTROL,
-    PARAM_MULTI_FLAG,
-    API_ENDPOINT_GET_DEVICE_POWER_INFO,
-    API_ENDPOINT_GET_PRODUCT_MODEL,
-    API_ENDPOINT_GET_IOT_DEVICE_DETAIL_INFO,
-    PARAM_ABILITY_REFS,
-    PARAM_CHANNELS,
-    PARAM_ACCESS_TYPE,
-    API_ENDPOINT_WAKE_UP_DEVICE,
+    PARAM_STREAM_ID,
     PARAM_URL,
-    NIGHT_VISION_MODE_MAP,
 )
 from .openapi import ImouOpenApiClient