relayx-app-sdk 0.1.0__tar.gz

relayx_app_sdk-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

relayx_app_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,14 @@
+Metadata-Version: 2.4
+Name: relayx_app_sdk
+Version: 0.1.0
+Summary: RelayX App SDK for Python
+License: Apache-2.0
+Requires-Python: >=3.9
+License-File: LICENSE
+Requires-Dist: nats-py>=2.9.0
+Requires-Dist: msgpack>=1.0.0
+Requires-Dist: nkeys==0.2.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
+Dynamic: license-file

relayx_app_sdk-0.1.0/README.md

@@ -0,0 +1,473 @@
+# RelayX App SDK for Python
+
+Official Python SDK for building applications on the RelayX platform.
+
+> **[View Full Documentation →](https://docs.relay-x.io/app-sdk/overview)**
+
+## Installation
+
+```bash
+pip install relayx_app_sdk
+```
+
+## Quick Start
+
+```python
+import asyncio
+from relayx_app_sdk import RelayApp
+
+app = RelayApp({
+    "api_key": "<YOUR_API_KEY>",
+    "secret": "<YOUR_SECRET>",
+    "mode": "production",
+})
+
+async def main():
+    app.connection.listeners(lambda event: print(f"[connection] {event}"))
+    await app.connect()
+
+    await app.telemetry.stream({
+        "device_ident": "sensor-1",
+        "metric": "temperature",
+        "callback": lambda data: print(f"temp: {data}"),
+    })
+
+    # ... your application logic ...
+
+    await app.disconnect()
+
+asyncio.run(main())
+```
+
+## Configuration
+
+```python
+app = RelayApp({
+    "api_key": "<YOUR_API_KEY>",   # JWT credential from RelayX console
+    "secret": "<YOUR_SECRET>",      # Secret key
+    "mode": "production",           # "production" | "test"
+    "debug": False,                 # Enable debug logging (default: False)
+})
+```
+
+Get your credentials at [console.relay-x.io](https://console.relay-x.io).
+<!-- TODO: Link to sign-up tutorial -->
+
+## Connection
+
+```python
+await app.connect()
+await app.disconnect()
+
+# Connection lifecycle events
+app.connection.listeners(lambda event: print(event))
+# Events: "connected" | "disconnected" | "reconnecting" | "reconnected" | "auth_failed"
+```
+
+### Presence
+
+Subscribe to device connect/disconnect events.
+
+```python
+async def on_presence(data):
+    print(f"{data['device_ident']} {data['event']}")
+    # data["event"]: "connected" | "disconnected"
+
+await app.connection.presence(on_presence)
+
+# Unsubscribe
+await app.connection.presence_off()
+```
+
+## Devices
+
+```python
+# List all devices
+devices = await app.device.list()
+
+# Get a single device
+device = await app.device.get({"ident": "sensor-1"})
+
+# Create a device
+device = await app.device.create({
+    "ident": "sensor-1",
+    "schema": {
+        "temperature": {"type": "number", "unit": "Celsius", "unit_symbol": "°C"},
+        "humidity": {"type": "number", "unit": "Percentage", "unit_symbol": "%"},
+    },
+    "config": {},
+})
+
+# Update a device
+device = await app.device.update({
+    "id": device["id"],
+    "config": {"interval": 5000},
+})
+
+# Delete a device
+await app.device.delete("sensor-1")
+```
+
+## Telemetry
+
+### Live Streaming
+
+Stream real-time telemetry from a device. The `metric` is validated against the device schema.
+
+```python
+# Stream a specific metric
+await app.telemetry.stream({
+    "device_ident": "sensor-1",
+    "metric": "temperature",
+    "callback": lambda data: print(f"[{data['metric']}] {data['data']}"),
+})
+
+# Stream all metrics
+await app.telemetry.stream({
+    "device_ident": "sensor-1",
+    "metric": "*",
+    "callback": lambda data: print(data),
+})
+
+# Unsubscribe from specific metrics
+await app.telemetry.off({"device_ident": "sensor-1", "metric": ["temperature"]})
+
+# Unsubscribe from all metrics for a device
+await app.telemetry.off({"device_ident": "sensor-1"})
+```
+
+### History
+
+```python
+history = await app.telemetry.history({
+    "device_ident": "sensor-1",
+    "fields": ["temperature", "humidity"],
+    "start": "2026-03-01T00:00:00.000Z",
+    "end": "2026-03-25T00:00:00.000Z",
+})
+```
+
+### Latest
+
+Fetches the most recent telemetry values (last 24 hours).
+
+```python
+latest = await app.telemetry.latest({
+    "device_ident": "sensor-1",
+    "fields": ["temperature", "humidity"],
+})
+```
+
+## Commands
+
+Send one-way commands to devices.
+
+```python
+# Send to one or more devices
+result = await app.command.send({
+    "name": "set_interval",
+    "device_ident": ["sensor-1", "sensor-2"],
+    "data": {"interval": 5000},
+})
+# result: {"sensor-1": {"sent": True}, "sensor-2": {"sent": True}}
+
+# Command history
+history = await app.command.history({
+    "name": "set_interval",
+    "device_idents": ["sensor-1"],
+    "start": "2026-03-01T00:00:00.000Z",
+    "end": "2026-03-25T00:00:00.000Z",
+})
+```
+
+## RPC
+
+Make request/reply calls to devices.
+
+```python
+response = await app.rpc.call({
+    "device_ident": "sensor-1",
+    "name": "get_status",
+    "data": {"verbose": True},
+    "timeout": 10,  # seconds (default: 10)
+})
+```
+
+## Events
+
+Subscribe to device-published events.
+
+```python
+await app.events.stream({
+    "name": "door_opened",
+    "callback": lambda data: print(f"Event: {data}"),
+})
+
+await app.events.off({"name": "door_opened"})
+```
+
+## Alerts
+
+### CRUD
+
+```python
+# Create a threshold alert
+alert = await app.alert.create({
+    "name": "high-temp",
+    "type": "THRESHOLD",  # "THRESHOLD" | "RATE_CHANGE"
+    "metric": "temperature",
+    "config": {"threshold": 85, "duration": 5},
+    "notification_channel": ["ops-webhook"],
+})
+
+# Get, update, delete
+alert = await app.alert.get("high-temp")
+alert = await app.alert.update({"id": alert["id"], "config": {"threshold": 90}})
+await app.alert.delete(alert["id"])
+
+# List all alerts
+alerts = await app.alert.list()
+```
+
+### Listening
+
+```python
+alert = await app.alert.get("high-temp")
+
+await alert.listen({
+    "on_fire": lambda data: print("FIRED:", data),
+    "on_resolved": lambda data: print("RESOLVED:", data),
+    "on_ack": lambda data: print("ACK:", data),
+    "on_ack_all": lambda data: print("ACK ALL:", data),
+})
+```
+
+### History
+
+```python
+history = await app.alert.history({
+    "rule_type": "RULE",  # "RULE" | "DEVICE"
+    "rule_id": alert["id"],
+    "rule_states": ["fire", "resolved"],
+    "start": "2026-03-01T00:00:00.000Z",
+    "end": "2026-03-25T00:00:00.000Z",
+})
+```
+
+### Acknowledge
+
+```python
+# Acknowledge for a specific device
+await app.alert.ack({
+    "device_id": "<device_id>",
+    "alert_id": alert["id"],
+    "acked_by": "operator-1",
+    "ack_notes": "Investigating",
+})
+
+# Acknowledge all instances
+await app.alert.ack_all({
+    "alert_id": alert["id"],
+    "acked_by": "operator-1",
+})
+```
+
+### Mute / Unmute
+
+```python
+await app.alert.mute({
+    "id": alert["id"],
+    "mute_config": {"type": "FOREVER"},
+    # or {"type": "TIME_BASED", "mute_till": "2026-04-01T00:00:00.000Z"}
+})
+
+await app.alert.unmute(alert["id"])
+```
+
+## Ephemeral Alerts
+
+Ephemeral alerts let you define custom alert rules that are evaluated client-side with your own logic. See the full guide: [Ephemeral Alerting Guide](docs/ephemeral-alerting.md).
+
+```python
+# Create an ephemeral alert
+alert = await app.alert.create_ephemeral({
+    "name": "custom-temp-alert",
+    "config": {
+        "topic": {
+            "source": "TELEMETRY",
+            "device_ident": "sensor-1",
+            "last_token": "temperature",
+        },
+        "duration": 5,
+        "recovery_duration": 10,
+        "recovery_eval_type": "VALUE",
+    },
+})
+
+# Set your evaluator
+alert.set_evaluator(
+    lambda state: state.get("sensor-1", {}).get("temperature", {}).get("value", 0) > 85
+)
+
+# Start monitoring
+await alert.listen({
+    "on_fire": lambda data: print("ALERT:", data),
+    "on_resolved": lambda data: print("RESOLVED:", data),
+})
+
+# Stop
+await alert.stop()
+```
+
+## Logical Groups
+
+Group devices by tags for batch operations and streaming.
+
+```python
+# Create
+group = await app.logical_group.create({
+    "name": "floor-1-sensors",
+    "tags": ["floor_1", "temperature"],
+    "device_idents": ["sensor-1", "sensor-2"],
+})
+
+# Update membership
+group = await app.logical_group.update({
+    "id": group["id"],
+    "devices": {"add": ["sensor-3"], "remove": ["sensor-1"]},
+    "tags": {"add": ["humidity"], "remove": ["floor_1"]},
+})
+
+# List, get, delete
+groups = await app.logical_group.list()
+group = await app.logical_group.get(group["id"])
+devices = await app.logical_group.list_devices(group["id"])
+await app.logical_group.delete(group["id"])
+```
+
+### Group Streaming
+
+Each group instance has `stream()` and `off()` methods.
+
+```python
+group = await app.logical_group.get("<group_id>")
+
+await group.stream({
+    "callback": lambda data: print(data),
+})
+
+await group.off()
+```
+
+## Hierarchy Groups
+
+Organize devices in a hierarchy path (e.g., `building_1.floor_2.zone_a`).
+
+```python
+# Create
+group = await app.heirarchy_group.create({
+    "name": "zone-a-sensors",
+    "heirarchy": "building_1.floor_2.zone_a",
+    "device_idents": ["sensor-1", "sensor-2"],
+})
+
+# Update
+group = await app.heirarchy_group.update({
+    "id": group["id"],
+    "devices": {"add": ["sensor-3"], "remove": []},
+    "heirarchy": "building_1.floor_3.zone_a",
+})
+
+# List, get, delete
+groups = await app.heirarchy_group.list()
+group = await app.heirarchy_group.get(group["id"])
+devices = await app.heirarchy_group.list_devices(group["id"])
+await app.heirarchy_group.delete(group["id"])
+```
+
+### Hierarchy Group Streaming
+
+Supports metric and hierarchy path filtering with wildcards.
+
+```python
+group = await app.heirarchy_group.get("<group_id>")
+
+# Stream all data
+await group.stream({"callback": lambda data: print(data)})
+
+# Filter by metric
+await group.stream({
+    "metric": "temperature",
+    "callback": lambda data: print(data),
+})
+
+# Filter by hierarchy path (supports * and > wildcards)
+await group.stream({
+    "heirarchy": "building_1.*.zone_a",
+    "callback": lambda data: print(data),
+})
+
+await group.off()
+```
+
+## Notifications
+
+Create webhook or email notification channels for alerts.
+
+```python
+# Webhook
+notif = await app.notification.create({
+    "name": "ops-webhook",
+    "type": "WEBHOOK",
+    "config": {"endpoint": "https://hooks.example.com/alerts"},
+})
+
+# Email
+notif = await app.notification.create({
+    "name": "ops-email",
+    "type": "EMAIL",
+    "config": {
+        "recipients": ["ops@example.com"],
+        "subject": "Alert Notification",
+        "template": "Alert {{alert_name}} fired on {{device_ident}}",
+    },
+})
+
+# Update, delete, list, get
+notif = await app.notification.update({
+    "name": "ops-webhook",
+    "type": "WEBHOOK",
+    "config": {"endpoint": "https://new-url.com"},
+})
+await app.notification.delete(notif["id"])
+notifs = await app.notification.list()
+notif = await app.notification.get("<notif_id>")
+```
+
+## Offline Behavior
+
+- **Commands**: Buffered in memory while disconnected and flushed automatically on reconnect.
+- **Subscriptions**: All active telemetry, event, presence, alert, and group stream subscriptions are automatically restored on reconnect.
+- **Ephemeral Alerts**: Alert state events (fire, resolved, ack) are buffered and published on reconnect.
+
+## Error Handling
+
+The SDK raises standard Python exceptions:
+
+- `ValueError` — Invalid arguments, missing required fields, schema validation failures
+- `RuntimeError` — Operations attempted while disconnected
+
+```python
+try:
+    await app.telemetry.stream({
+        "device_ident": "sensor-1",
+        "metric": "nonexistent",
+        "callback": lambda d: None,
+    })
+except ValueError as e:
+    print(f"Validation error: {e}")
+```
+
+## License
+
+Apache-2.0