@uns-kit/cli 0.0.36 → 0.0.37

package/templates/python/examples/README.md

@@ -1,134 +1,134 @@
-# Python Examples for the UNS gRPC Gateway
-
-These examples demonstrate how to use the Node-based UNS Gateway (MQTT + UNS infra) from Python via gRPC. They mirror the TypeScript examples for data, table, cron-like publishing, and API endpoints.
-
-The gateway centralizes all UNS rules (packet format, sequenceId, interval, produced topics, handover). Python focuses on business logic and ML/ETL while calling the gateway.
-
-## Prerequisites
-
-- Build the Node project once: `npm run build`
-- Generate Python stubs and venv: `cd python && ./scripts/setup.sh && source venv/bin/activate`
-- Ensure `config.json` is present at repo root (Node gateway reads brokers and UNS options from it)
-
-## Gateway Address
-
-- If `--addr` is omitted, each script auto‑generates a unique address:
-  - Unix/macOS: `unix:/tmp/uns-gateway-<script>-<pid>.sock`
-  - Windows: `127.0.0.1:<ephemeral_port>`
-- You can still pass an explicit `--addr` if you want a fixed address.
-
-All examples accept `--addr` and `--auto`. With `--auto`, the example will spawn the gateway via `npm run gateway` and wait until it's ready.
-
-Imports note: Examples add the generated stubs folder (`python/gen`) to `sys.path` so you can run them from the repo root or from the `python/` folder. Ensure you’ve run `./scripts/setup.sh` so `gen` exists.
-
-Readiness: Examples call the gateway’s `Ready()` RPC to wait for the requested components (publisher/subscriber/API) to be active before publishing or subscribing. No manual sleeps are required.
-
-## Common Flags
-
-- `--addr`: Gateway address (`unix:/path.sock` or `host:port`)
-- `--auto`: Auto-start the gateway if not running
-
-## Scripts
-### `data_transformer.py`
-
-Transforms incoming sensor data and republishes it to a target topic.
-
--   **Description:**  
-    Subscribes to `sensors/temperature`, applies a transformation (e.g., scales the value), and republishes it as processed data.
-    
--   **Example:**
-    
-    ```bash
-    python python/examples/data_transformer.py
-    ```
-    
-    Transforms data from `sensors/temperature` and republishes to `sensors/temperature/room1` it with a modified value.
-    
-
----
-
-### `data_subscribe.py`
-
-Subscribes to topics via the gateway and prints received messages.
-
--   **Description:**  
-    Useful for monitoring live data updates.
-    
--   **Example:**
-    
-    ```bash
-    python python/examples/data_subscribe.py
-    ```
-    
-    Prints all messages received from `sensors/temperature`.
-    
-
----
-
-### `data_publish.py`
-
-Publishes a single data point to a UNS topic.
-
--   **Description:**  
-    Sends a single temperature measurement (e.g., 22.5 °C) to the gateway, waits 10 seconds, then exits.
-    
--   **Example:**
-    
-    ```bash
-    python python/examples/data_publish.py
-    ```
-    
-    Publishes one temperature value to `sensors/temperature/room1`.
-    
-
----
-
-### `table_transformer.py`
-
-Publishes a structured table-like JSON object as UNS table data.
-
--   **Description:**  
-    Sends summarized or grouped sensor data (e.g., temperature, humidity, status) to a topic.
-    
--   **Example:**
-    
-    ```bash
-    python python/examples/dtable_transformer.py
-    ```
-    
-    Publishes a table with room statistics (temperature, humidity, etc.) to `sensors/summary/room1`.
-    
-
----
-
-### `api_handler.py`
-
-Registers and handles an example API endpoint for querying data.
-
--   **Description:**  
-    Demonstrates registering an API endpoint (`example/summary-1`) with query parameters and returning JSON responses.
-    
--   **Example:**
-    
-    ```bash
-    python python/examples/api_handler.py
-    ```
-    
-    Then test it with:
-    
-    ```bash
-    http://<gateway-host>:<gateway-port>/api/example/summary-1?filter=test&limit=10
-    ```
-
-## Auth
-
-- If `config.json` sets `uns.jwksWellKnownUrl`, the gateway enforces JWT via JWKS (and path rules), matching UnsApiProxy behavior.
-- Otherwise, it uses a dev `jwtSecret` ("CHANGEME"). For local testing, you can:
-  - Remove JWKS settings in `config.json` and rely on the dev secret, or
-  - Provide a valid Bearer token as required by your environment.
-
-## Notes
-
-- The gateway binds to `--addr` or the `UNS_GATEWAY_ADDR` env var. Examples pass `--addr` explicitly.
-- On Unix/macOS, a stable UDS path (e.g., `/tmp/uns-gateway.sock`) is recommended for simplicity.
-- All examples will auto-start the gateway when `--auto` is used.
+# Python Examples for the UNS gRPC Gateway
+
+These examples demonstrate how to use the Node-based UNS Gateway (MQTT + UNS infra) from Python via gRPC. They mirror the TypeScript examples for data, table, cron-like publishing, and API endpoints.
+
+The gateway centralizes all UNS rules (packet format, sequenceId, interval, produced topics, handover). Python focuses on business logic and ML/ETL while calling the gateway.
+
+## Prerequisites
+
+- Build the Node project once: `npm run build`
+- Generate Python stubs and venv: `cd python && ./scripts/setup.sh && source venv/bin/activate`
+- Ensure `config.json` is present at repo root (Node gateway reads brokers and UNS options from it)
+
+## Gateway Address
+
+- If `--addr` is omitted, each script auto‑generates a unique address:
+  - Unix/macOS: `unix:/tmp/uns-gateway-<script>-<pid>.sock`
+  - Windows: `127.0.0.1:<ephemeral_port>`
+- You can still pass an explicit `--addr` if you want a fixed address.
+
+All examples accept `--addr` and `--auto`. With `--auto`, the example will spawn the gateway via `npm run gateway` and wait until it's ready.
+
+Imports note: Examples add the generated stubs folder (`python/gen`) to `sys.path` so you can run them from the repo root or from the `python/` folder. Ensure you’ve run `./scripts/setup.sh` so `gen` exists.
+
+Readiness: Examples call the gateway’s `Ready()` RPC to wait for the requested components (publisher/subscriber/API) to be active before publishing or subscribing. No manual sleeps are required.
+
+## Common Flags
+
+- `--addr`: Gateway address (`unix:/path.sock` or `host:port`)
+- `--auto`: Auto-start the gateway if not running
+
+## Scripts
+### `data_transformer.py`
+
+Transforms incoming sensor data and republishes it to a target topic.
+
+-   **Description:**  
+    Subscribes to `sensors/temperature`, applies a transformation (e.g., scales the value), and republishes it as processed data.
+    
+-   **Example:**
+    
+    ```bash
+    python python/examples/data_transformer.py
+    ```
+    
+    Transforms data from `sensors/temperature` and republishes to `sensors/temperature/room1` it with a modified value.
+    
+
+---
+
+### `data_subscribe.py`
+
+Subscribes to topics via the gateway and prints received messages.
+
+-   **Description:**  
+    Useful for monitoring live data updates.
+    
+-   **Example:**
+    
+    ```bash
+    python python/examples/data_subscribe.py
+    ```
+    
+    Prints all messages received from `sensors/temperature`.
+    
+
+---
+
+### `data_publish.py`
+
+Publishes a single data point to a UNS topic.
+
+-   **Description:**  
+    Sends a single temperature measurement (e.g., 22.5 °C) to the gateway, waits 10 seconds, then exits.
+    
+-   **Example:**
+    
+    ```bash
+    python python/examples/data_publish.py
+    ```
+    
+    Publishes one temperature value to `sensors/temperature/room1`.
+    
+
+---
+
+### `table_transformer.py`
+
+Publishes a structured table-like JSON object as UNS table data.
+
+-   **Description:**  
+    Sends summarized or grouped sensor data (e.g., temperature, humidity, status) to a topic.
+    
+-   **Example:**
+    
+    ```bash
+    python python/examples/dtable_transformer.py
+    ```
+    
+    Publishes a table with room statistics (temperature, humidity, etc.) to `sensors/summary/room1`.
+    
+
+---
+
+### `api_handler.py`
+
+Registers and handles an example API endpoint for querying data.
+
+-   **Description:**  
+    Demonstrates registering an API endpoint (`example/summary-1`) with query parameters and returning JSON responses.
+    
+-   **Example:**
+    
+    ```bash
+    python python/examples/api_handler.py
+    ```
+    
+    Then test it with:
+    
+    ```bash
+    http://<gateway-host>:<gateway-port>/api/example/summary-1?filter=test&limit=10
+    ```
+
+## Auth
+
+- If `config.json` sets `uns.jwksWellKnownUrl`, the gateway enforces JWT via JWKS (and path rules), matching UnsApiProxy behavior.
+- Otherwise, it uses a dev `jwtSecret` ("CHANGEME"). For local testing, you can:
+  - Remove JWKS settings in `config.json` and rely on the dev secret, or
+  - Provide a valid Bearer token as required by your environment.
+
+## Notes
+
+- The gateway binds to `--addr` or the `UNS_GATEWAY_ADDR` env var. Examples pass `--addr` explicitly.
+- On Unix/macOS, a stable UDS path (e.g., `/tmp/uns-gateway.sock`) is recommended for simplicity.
+- All examples will auto-start the gateway when `--auto` is used.

package/templates/python/examples/api_handler.py

@@ -1,28 +1,28 @@
-from gateway.client import Client
-from uns_gateway_pb2 import ApiQueryParam, ApiEventResponse
-import json
-
-client = Client()
-
-# Register API with structured query params
-qp = [
-    ApiQueryParam(name="filter", type="string", required=True, description="Filter za podatke"),
-    ApiQueryParam(name="limit", type="number", required=False, description="Koliko podatkov želiš"),
-]
-
-client.register_api(
-    topic="example/",
-    attribute="summary-1",
-    desc="Example API endpoint",
-    tags=["example", "demo"],
-    query_params=qp
-)
-
-# Handle API events
-def handle_api(ev):
-    print(f"API request: {ev.path}, query={dict(ev.query)}")
-    body = {"status": "OK", "path": ev.path, "query": dict(ev.query)}
-    return ApiEventResponse(id=ev.id, status=200, headers={"Content-Type": "application/json"},
-                            body=json.dumps(body))
-
-client.api_stream(handle_event=handle_api)
+from gateway.client import Client
+from uns_gateway_pb2 import ApiQueryParam, ApiEventResponse
+import json
+
+client = Client()
+
+# Register API with structured query params
+qp = [
+    ApiQueryParam(name="filter", type="string", required=True, description="Filter za podatke"),
+    ApiQueryParam(name="limit", type="number", required=False, description="Koliko podatkov želiš"),
+]
+
+client.register_api(
+    topic="example/",
+    attribute="summary-1",
+    desc="Example API endpoint",
+    tags=["example", "demo"],
+    query_params=qp
+)
+
+# Handle API events
+def handle_api(ev):
+    print(f"API request: {ev.path}, query={dict(ev.query)}")
+    body = {"status": "OK", "path": ev.path, "query": dict(ev.query)}
+    return ApiEventResponse(id=ev.id, status=200, headers={"Content-Type": "application/json"},
+                            body=json.dumps(body))
+
+client.api_stream(handle_event=handle_api)

package/templates/python/examples/data_publish.py

@@ -1,11 +1,11 @@
-from gateway.client import Client
-import time
-# Publish a single data point
-client = Client()
-client.publish_data(
-    topic="sensors/temperature",
-    attribute="room1",
-    value=22.5,
-    uom="°C"
-)
-time.sleep(10)
+from gateway.client import Client
+import time
+# Publish a single data point
+client = Client()
+client.publish_data(
+    topic="sensors/temperature",
+    attribute="room1",
+    value=22.5,
+    uom="°C"
+)
+time.sleep(10)

package/templates/python/examples/data_subscribe.py

@@ -1,8 +1,8 @@
-from gateway.client import Client
-
-def handle_message(msg):
-    print(f"Callback got {msg.topic}: {msg.payload}")
-    # You could also transform, save, or push to another service
-
-client = Client()
-client.subscribe(["sensors/temperature"], callback=handle_message)
+from gateway.client import Client
+
+def handle_message(msg):
+    print(f"Callback got {msg.topic}: {msg.payload}")
+    # You could also transform, save, or push to another service
+
+client = Client()
+client.subscribe(["sensors/temperature"], callback=handle_message)

package/templates/python/examples/data_transformer.py

@@ -1,17 +1,17 @@
-from gateway.client import Client, iso_now
-import json
-
-client = Client()
-    
-def transform_data(value):
-    
-    return value * 1.1
-
-def handle_message(msg):
-    payload = json.loads(msg.payload)
-    value = float(payload["value"])
-    
-    transformed_value = transform_data(value)
-    client.publish_data("sensors/temperature", "room1", value=transformed_value, uom="°C")
-
-client.subscribe(["sensors/temperature"], callback=handle_message)
+from gateway.client import Client, iso_now
+import json
+
+client = Client()
+    
+def transform_data(value):
+    
+    return value * 1.1
+
+def handle_message(msg):
+    payload = json.loads(msg.payload)
+    value = float(payload["value"])
+    
+    transformed_value = transform_data(value)
+    client.publish_data("sensors/temperature", "room1", value=transformed_value, uom="°C")
+
+client.subscribe(["sensors/temperature"], callback=handle_message)

package/templates/python/examples/table_transformer.py

@@ -1,16 +1,16 @@
-from gateway.client import Client, iso_now
-import time
-
-client = Client()
-client.publish_table(
-    topic="sensors/summary/",
-    attribute="room1",
-    obj={
-        "temperature": 22.5,
-        "humidity": 55.2,
-        "status": "ok",
-        "error": None
-    },
-    data_group="room_stats"
-)
+from gateway.client import Client, iso_now
+import time
+
+client = Client()
+client.publish_table(
+    topic="sensors/summary/",
+    attribute="room1",
+    obj={
+        "temperature": 22.5,
+        "humidity": 55.2,
+        "status": "ok",
+        "error": None
+    },
+    data_group="room_stats"
+)
 time.sleep(10)

package/templates/python/gateway/cli.py

@@ -1,75 +1,75 @@
-import argparse
-from .manager import GatewayManager
-from . import client
-import uns_gateway_pb2_grpc as gw
-from .client import make_channel
-
-def main():
-    parser = argparse.ArgumentParser()
-    parser.add_argument("--addr", default=None)
-    sub = parser.add_subparsers(dest="cmd", required=True)
-
-    # --- Publish ---
-    p_pub = sub.add_parser("pub")
-    p_pub.add_argument("topic")
-    p_pub.add_argument("attribute")
-    p_pub.add_argument("time_iso")
-    p_pub.add_argument("value", type=float)
-    p_pub.add_argument("--uom", default="")
-    p_pub.add_argument("--group", default="")
-    p_pub.add_argument("--cumulative", action="store_true")
-    p_pub.add_argument("--auto", action="store_true")
-
-    # --- Subscribe ---
-    p_sub = sub.add_parser("sub")
-    p_sub.add_argument("topics", nargs="+")
-    p_sub.add_argument("--auto", action="store_true")
-
-    # --- Register API ---
-    p_reg = sub.add_parser("regapi")
-    p_reg.add_argument("topic")
-    p_reg.add_argument("attribute")
-    p_reg.add_argument("--desc", default="")
-    p_reg.add_argument("--tag", action="append", default=[])
-    p_reg.add_argument("--param", action="append", default=[])
-    p_reg.add_argument("--auto", action="store_true")
-
-    # --- Unregister API ---
-    p_unreg = sub.add_parser("unregapi")
-    p_unreg.add_argument("topic")
-    p_unreg.add_argument("attribute")
-    p_unreg.add_argument("--auto", action="store_true")
-
-    # --- API Stream ---
-    p_stream = sub.add_parser("apistream")
-    p_stream.add_argument("--echo", action="store_true")
-    p_stream.add_argument("--auto", action="store_true")
-
-    args = parser.parse_args()
-    mgr = GatewayManager(args.addr, auto=getattr(args, "auto", False))
-    addr = mgr.ensure_running()
-
-    if args.cmd == "pub":
-        client.publish_data(
-            addr, topic=args.topic, attribute=args.attribute,
-            time_iso=args.time_iso, value_number=args.value,
-            uom=args.uom, data_group=args.group,
-            value_is_cumulative=args.cumulative
-        )
-    elif args.cmd == "sub":
-        client.subscribe(addr, args.topics)
-    elif args.cmd == "regapi":
-        with make_channel(addr) as ch:
-            stub = gw.UnsGatewayStub(ch)
-            client.register_api(stub, args.topic, args.attribute, args.desc, args.tag, args.param)
-            print("registered")
-    elif args.cmd == "unregapi":
-        with make_channel(addr) as ch:
-            stub = gw.UnsGatewayStub(ch)
-            client.unregister_api(stub, args.topic, args.attribute)
-            print("unregistered")
-    elif args.cmd == "apistream":
-        client.api_stream(addr, echo=args.echo)
-
-if __name__ == "__main__":
-    main()
+import argparse
+from .manager import GatewayManager
+from . import client
+import uns_gateway_pb2_grpc as gw
+from .client import make_channel
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--addr", default=None)
+    sub = parser.add_subparsers(dest="cmd", required=True)
+
+    # --- Publish ---
+    p_pub = sub.add_parser("pub")
+    p_pub.add_argument("topic")
+    p_pub.add_argument("attribute")
+    p_pub.add_argument("time_iso")
+    p_pub.add_argument("value", type=float)
+    p_pub.add_argument("--uom", default="")
+    p_pub.add_argument("--group", default="")
+    p_pub.add_argument("--cumulative", action="store_true")
+    p_pub.add_argument("--auto", action="store_true")
+
+    # --- Subscribe ---
+    p_sub = sub.add_parser("sub")
+    p_sub.add_argument("topics", nargs="+")
+    p_sub.add_argument("--auto", action="store_true")
+
+    # --- Register API ---
+    p_reg = sub.add_parser("regapi")
+    p_reg.add_argument("topic")
+    p_reg.add_argument("attribute")
+    p_reg.add_argument("--desc", default="")
+    p_reg.add_argument("--tag", action="append", default=[])
+    p_reg.add_argument("--param", action="append", default=[])
+    p_reg.add_argument("--auto", action="store_true")
+
+    # --- Unregister API ---
+    p_unreg = sub.add_parser("unregapi")
+    p_unreg.add_argument("topic")
+    p_unreg.add_argument("attribute")
+    p_unreg.add_argument("--auto", action="store_true")
+
+    # --- API Stream ---
+    p_stream = sub.add_parser("apistream")
+    p_stream.add_argument("--echo", action="store_true")
+    p_stream.add_argument("--auto", action="store_true")
+
+    args = parser.parse_args()
+    mgr = GatewayManager(args.addr, auto=getattr(args, "auto", False))
+    addr = mgr.ensure_running()
+
+    if args.cmd == "pub":
+        client.publish_data(
+            addr, topic=args.topic, attribute=args.attribute,
+            time_iso=args.time_iso, value_number=args.value,
+            uom=args.uom, data_group=args.group,
+            value_is_cumulative=args.cumulative
+        )
+    elif args.cmd == "sub":
+        client.subscribe(addr, args.topics)
+    elif args.cmd == "regapi":
+        with make_channel(addr) as ch:
+            stub = gw.UnsGatewayStub(ch)
+            client.register_api(stub, args.topic, args.attribute, args.desc, args.tag, args.param)
+            print("registered")
+    elif args.cmd == "unregapi":
+        with make_channel(addr) as ch:
+            stub = gw.UnsGatewayStub(ch)
+            client.unregister_api(stub, args.topic, args.attribute)
+            print("unregistered")
+    elif args.cmd == "apistream":
+        client.api_stream(addr, echo=args.echo)
+
+if __name__ == "__main__":
+    main()