@uns-kit/cli 0.0.34 → 0.0.36

package/templates/python/gen/uns_gateway_pb2_grpc.py

@@ -0,0 +1,312 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+from . import uns_gateway_pb2 as uns__gateway__pb2
+
+GRPC_GENERATED_VERSION = '1.75.1'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + f' but the generated code in uns_gateway_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )
+
+
+class UnsGatewayStub(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.Publish = channel.unary_unary(
+                '/uns.UnsGateway/Publish',
+                request_serializer=uns__gateway__pb2.PublishRequest.SerializeToString,
+                response_deserializer=uns__gateway__pb2.Ack.FromString,
+                _registered_method=True)
+        self.Subscribe = channel.unary_stream(
+                '/uns.UnsGateway/Subscribe',
+                request_serializer=uns__gateway__pb2.SubscribeRequest.SerializeToString,
+                response_deserializer=uns__gateway__pb2.MqttMessage.FromString,
+                _registered_method=True)
+        self.RegisterApiGet = channel.unary_unary(
+                '/uns.UnsGateway/RegisterApiGet',
+                request_serializer=uns__gateway__pb2.RegisterApiGetRequest.SerializeToString,
+                response_deserializer=uns__gateway__pb2.Ack.FromString,
+                _registered_method=True)
+        self.UnregisterApiGet = channel.unary_unary(
+                '/uns.UnsGateway/UnregisterApiGet',
+                request_serializer=uns__gateway__pb2.UnregisterApiGetRequest.SerializeToString,
+                response_deserializer=uns__gateway__pb2.Ack.FromString,
+                _registered_method=True)
+        self.ApiEventStream = channel.stream_stream(
+                '/uns.UnsGateway/ApiEventStream',
+                request_serializer=uns__gateway__pb2.ApiEventResponse.SerializeToString,
+                response_deserializer=uns__gateway__pb2.ApiEvent.FromString,
+                _registered_method=True)
+        self.Ready = channel.unary_unary(
+                '/uns.UnsGateway/Ready',
+                request_serializer=uns__gateway__pb2.ReadyRequest.SerializeToString,
+                response_deserializer=uns__gateway__pb2.Ack.FromString,
+                _registered_method=True)
+
+
+class UnsGatewayServicer(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def Publish(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def Subscribe(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def RegisterApiGet(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def UnregisterApiGet(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def ApiEventStream(self, request_iterator, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def Ready(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_UnsGatewayServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'Publish': grpc.unary_unary_rpc_method_handler(
+                    servicer.Publish,
+                    request_deserializer=uns__gateway__pb2.PublishRequest.FromString,
+                    response_serializer=uns__gateway__pb2.Ack.SerializeToString,
+            ),
+            'Subscribe': grpc.unary_stream_rpc_method_handler(
+                    servicer.Subscribe,
+                    request_deserializer=uns__gateway__pb2.SubscribeRequest.FromString,
+                    response_serializer=uns__gateway__pb2.MqttMessage.SerializeToString,
+            ),
+            'RegisterApiGet': grpc.unary_unary_rpc_method_handler(
+                    servicer.RegisterApiGet,
+                    request_deserializer=uns__gateway__pb2.RegisterApiGetRequest.FromString,
+                    response_serializer=uns__gateway__pb2.Ack.SerializeToString,
+            ),
+            'UnregisterApiGet': grpc.unary_unary_rpc_method_handler(
+                    servicer.UnregisterApiGet,
+                    request_deserializer=uns__gateway__pb2.UnregisterApiGetRequest.FromString,
+                    response_serializer=uns__gateway__pb2.Ack.SerializeToString,
+            ),
+            'ApiEventStream': grpc.stream_stream_rpc_method_handler(
+                    servicer.ApiEventStream,
+                    request_deserializer=uns__gateway__pb2.ApiEventResponse.FromString,
+                    response_serializer=uns__gateway__pb2.ApiEvent.SerializeToString,
+            ),
+            'Ready': grpc.unary_unary_rpc_method_handler(
+                    servicer.Ready,
+                    request_deserializer=uns__gateway__pb2.ReadyRequest.FromString,
+                    response_serializer=uns__gateway__pb2.Ack.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'uns.UnsGateway', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+    server.add_registered_method_handlers('uns.UnsGateway', rpc_method_handlers)
+
+
+ # This class is part of an EXPERIMENTAL API.
+class UnsGateway(object):
+    """Missing associated documentation comment in .proto file."""
+
+    @staticmethod
+    def Publish(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/uns.UnsGateway/Publish',
+            uns__gateway__pb2.PublishRequest.SerializeToString,
+            uns__gateway__pb2.Ack.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def Subscribe(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(
+            request,
+            target,
+            '/uns.UnsGateway/Subscribe',
+            uns__gateway__pb2.SubscribeRequest.SerializeToString,
+            uns__gateway__pb2.MqttMessage.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def RegisterApiGet(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/uns.UnsGateway/RegisterApiGet',
+            uns__gateway__pb2.RegisterApiGetRequest.SerializeToString,
+            uns__gateway__pb2.Ack.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def UnregisterApiGet(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/uns.UnsGateway/UnregisterApiGet',
+            uns__gateway__pb2.UnregisterApiGetRequest.SerializeToString,
+            uns__gateway__pb2.Ack.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def ApiEventStream(request_iterator,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.stream_stream(
+            request_iterator,
+            target,
+            '/uns.UnsGateway/ApiEventStream',
+            uns__gateway__pb2.ApiEventResponse.SerializeToString,
+            uns__gateway__pb2.ApiEvent.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def Ready(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/uns.UnsGateway/Ready',
+            uns__gateway__pb2.ReadyRequest.SerializeToString,
+            uns__gateway__pb2.Ack.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)

package/templates/python/main.py

@@ -0,0 +1 @@
+"Main Logic"

package/templates/python/proto/uns-gateway.proto

@@ -1,102 +1,102 @@
-syntax = "proto3";
-
-package uns;
-
-service UnsGateway {
-  rpc Publish (PublishRequest) returns (Ack);
-  rpc Subscribe (SubscribeRequest) returns (stream MqttMessage);
-  rpc RegisterApiGet (RegisterApiGetRequest) returns (Ack);
-  rpc UnregisterApiGet (UnregisterApiGetRequest) returns (Ack);
-  rpc ApiEventStream (stream ApiEventResponse) returns (stream ApiEvent);
-  rpc Ready (ReadyRequest) returns (Ack);
-}
-
-message PublishRequest {
-  string topic = 1;
-  string attribute = 2;
-  string description = 3;
-  repeated string tags = 4;
-  bool attribute_needs_persistence = 5;
-  oneof content {
-    Data data = 6;
-    Table table = 7;
-  }
-  bool value_is_cumulative = 8; // for Data: publish as delta
-}
-
-message Data {
-  string time = 1;
-  double value_number = 2;
-  string value_string = 3;
-  string uom = 4;
-  string data_group = 5;
-  string foreign_event_key = 6;
-}
-
-message TableValue {
-  string key = 1;
-  double value_number = 2;
-  string value_string = 3;
-}
-
-message Table {
-  string time = 1;
-  repeated TableValue values = 2;
-  string data_group = 3;
-}
-
-message SubscribeRequest {
-  repeated string topics = 1;
-}
-
-message MqttMessage {
-  string topic = 1;
-  string payload = 2; // UNS packet JSON
-}
-
-message Ack {
-  bool ok = 1;
-  string error = 2;
-}
-
-message ReadyRequest {
-  int32 timeout_ms = 1;              // default 15000
-  bool wait_output = 2;              // wait for publisher active (output)
-  bool wait_input = 3;               // wait for subscriber active (input)
-  bool wait_api = 4;                 // wait for API server (optional)
-}
-
-message ApiQueryParam {
-  string name = 1;
-  string type = 2; // string | number | boolean
-  bool required = 3;
-  string description = 4;
-}
-
-message RegisterApiGetRequest {
-  string topic = 1;
-  string attribute = 2;
-  string api_description = 3;
-  repeated string tags = 4;
-  repeated ApiQueryParam query_params = 5;
-}
-
-message UnregisterApiGetRequest {
-  string topic = 1;
-  string attribute = 2;
-}
-
-message ApiEvent {
-  string id = 1;
-  string method = 2; // GET only for now
-  string path = 3;   // /{topic}{attribute}
-  map<string, string> query = 4;
-  string bearer = 5; // access token (optional)
-}
-
-message ApiEventResponse {
-  string id = 1;          // correlation
-  int32 status = 2;       // HTTP status
-  string body = 3;        // response body as string (JSON string if needed)
-  map<string, string> headers = 4; // optional extra headers
-}
+syntax = "proto3";
+
+package uns;
+
+service UnsGateway {
+  rpc Publish (PublishRequest) returns (Ack);
+  rpc Subscribe (SubscribeRequest) returns (stream MqttMessage);
+  rpc RegisterApiGet (RegisterApiGetRequest) returns (Ack);
+  rpc UnregisterApiGet (UnregisterApiGetRequest) returns (Ack);
+  rpc ApiEventStream (stream ApiEventResponse) returns (stream ApiEvent);
+  rpc Ready (ReadyRequest) returns (Ack);
+}
+
+message PublishRequest {
+  string topic = 1;
+  string attribute = 2;
+  string description = 3;
+  repeated string tags = 4;
+  bool attribute_needs_persistence = 5;
+  oneof content {
+    Data data = 6;
+    Table table = 7;
+  }
+  bool value_is_cumulative = 8; // for Data: publish as delta
+}
+
+message Data {
+  string time = 1;
+  double value_number = 2;
+  string value_string = 3;
+  string uom = 4;
+  string data_group = 5;
+  string foreign_event_key = 6;
+}
+
+message TableValue {
+  string key = 1;
+  double value_number = 2;
+  string value_string = 3;
+}
+
+message Table {
+  string time = 1;
+  repeated TableValue values = 2;
+  string data_group = 3;
+}
+
+message SubscribeRequest {
+  repeated string topics = 1;
+}
+
+message MqttMessage {
+  string topic = 1;
+  string payload = 2; // UNS packet JSON
+}
+
+message Ack {
+  bool ok = 1;
+  string error = 2;
+}
+
+message ReadyRequest {
+  int32 timeout_ms = 1;              // default 15000
+  bool wait_output = 2;              // wait for publisher active (output)
+  bool wait_input = 3;               // wait for subscriber active (input)
+  bool wait_api = 4;                 // wait for API server (optional)
+}
+
+message ApiQueryParam {
+  string name = 1;
+  string type = 2; // string | number | boolean
+  bool required = 3;
+  string description = 4;
+}
+
+message RegisterApiGetRequest {
+  string topic = 1;
+  string attribute = 2;
+  string api_description = 3;
+  repeated string tags = 4;
+  repeated ApiQueryParam query_params = 5;
+}
+
+message UnregisterApiGetRequest {
+  string topic = 1;
+  string attribute = 2;
+}
+
+message ApiEvent {
+  string id = 1;
+  string method = 2; // GET only for now
+  string path = 3;   // /{topic}{attribute}
+  map<string, string> query = 4;
+  string bearer = 5; // access token (optional)
+}
+
+message ApiEventResponse {
+  string id = 1;          // correlation
+  int32 status = 2;       // HTTP status
+  string body = 3;        // response body as string (JSON string if needed)
+  map<string, string> headers = 4; // optional extra headers
+}

package/templates/python/pyproject.toml

@@ -0,0 +1,5 @@
+[project]
+name = "uns-example"
+version = "0.1.0"
+description = "A new gRPC project"
+dependencies = ["grpcio", "grpcio-tools", "httpx>=0.27.2"]

package/templates/python/scripts/setup.sh

@@ -1,64 +1,87 @@
-#!/bin/bash
-
-set -euo pipefail
-
-# Navigate to the project root
-cd "$(dirname "$0")/.."
-
-# Detect OS and set python & venv paths
-PLATFORM="$(uname)"
-if [[ "$PLATFORM" == "Linux" || "$PLATFORM" == "Darwin" ]]; then
-  PYTHON_EXEC="python3"
-  VENV_DIR="venv"
-  VENV_ACTIVATE="./venv/bin/activate"
-elif [[ "$PLATFORM" =~ MINGW.* || "$PLATFORM" =~ CYGWIN.* || "$PLATFORM" == "MSYS_NT"* ]]; then
-  PYTHON_EXEC="python"
-  VENV_DIR="venv"
-  VENV_ACTIVATE="./venv/Scripts/activate"
-else
-  echo "[setup] Unsupported OS: $PLATFORM"
-  exit 1
-fi
-
-# Check if Python is available
-if ! command -v "$PYTHON_EXEC" &> /dev/null; then
-  echo "[setup] Error: $PYTHON_EXEC not found in PATH."
-  exit 1
-fi
-
-# Create virtual environment if it doesn't exist
-if [ ! -d "$VENV_DIR" ]; then
-  echo "[setup] Creating virtual environment in $VENV_DIR..."
-  "$PYTHON_EXEC" -m venv "$VENV_DIR"
-fi
-
-# Create gen directory if it doesn't exist
-if [ ! -d "gen" ]; then
-  echo "[setup] Creating gen directory..."
-  mkdir -p gen
-fi
-
-# Ensure gen is a package for imports
-if [ ! -f "gen/__init__.py" ]; then
-  echo "[setup] Creating gen/__init__.py..."
-  echo "# generated" > gen/__init__.py
-fi
-
-# Activate the virtual environment
-echo "[setup] Activating virtual environment..."
-source "$VENV_ACTIVATE"
-
-# Install Python dependencies using pip from venv
-echo "[setup] Installing requirements using pip from venv..."
-"$PYTHON_EXEC" -m pip install --upgrade pip
-"$PYTHON_EXEC" -m pip install -r requirements.txt
-
-# Generate Python gRPC code from the proto file
-echo "[setup] Generating gRPC Python code..."
-"$PYTHON_EXEC" -m grpc_tools.protoc \
-  -I=proto \
-  --python_out=gen \
-  --grpc_python_out=gen \
-  proto/uns-gateway.proto
-
-echo "[setup] Setup complete!"
+#!/bin/bash
+
+set -euo pipefail
+
+# Navigate to the project root
+cd "$(dirname "$0")/.."
+
+# Detect OS and set paths
+PLATFORM="$(uname)"
+if [[ "$PLATFORM" == "Linux" || "$PLATFORM" == "Darwin" ]]; then
+  PYTHON_EXEC="python3"
+  VENV_DIR="venv"
+  VENV_ACTIVATE="./venv/bin/activate"
+elif [[ "$PLATFORM" =~ MINGW.* || "$PLATFORM" =~ CYGWIN.* || "$PLATFORM" == "MSYS_NT"* ]]; then
+  PYTHON_EXEC="python"
+  VENV_DIR="venv"
+  VENV_ACTIVATE="./venv/Scripts/activate"
+else
+  echo "[setup] Unsupported OS: $PLATFORM"
+  exit 1
+fi
+
+if [[ "$PLATFORM" =~ MINGW.*|MSYS.*|CYGWIN.*|Windows_NT ]]; then
+    UV_CMD="$HOME/.local/bin/uv.exe"
+else
+    UV_CMD="$HOME/.cargo/bin/uv"
+fi
+
+if [ ! -f "$UV_CMD" ]; then
+    echo "[setup] uv not found. Installing it..."
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+else
+    echo "[setup] uv already installed at $UV_CMD"
+fi
+
+# Create virtual environment using uv
+if [ ! -d "$VENV_DIR" ]; then
+  echo "[setup] Creating virtual environment in $VENV_DIR using uv..."
+  "$UV_CMD" venv "$VENV_DIR"
+fi
+
+# Create gen directory if it doesn't exist
+if [ ! -d "gen" ]; then
+  echo "[setup] Creating gen directory..."
+  mkdir -p gen
+fi
+
+# Ensure gen is a package for imports
+if [ ! -f "gen/__init__.py" ]; then
+  echo "[setup] Creating gen/__init__.py..."
+  echo "# generated" > gen/__init__.py
+fi
+
+# Activate the virtual environment
+echo "[setup] Activating virtual environment..."
+if [[ "$PLATFORM" =~ MINGW.*|MSYS.*|CYGWIN.* ]]; then
+    # Windows Git Bash / MSYS
+    . "$VENV_ACTIVATE"
+else
+    # Linux / macOS
+    source "$VENV_ACTIVATE"
+fi
+
+# Install dependencies using uv (much faster than pip)
+echo "[setup] Installing requirements using uv..."
+"$UV_CMD" sync --active
+
+# Generate Python gRPC code from proto
+echo "[setup] Generating gRPC Python code..."
+"$PYTHON_EXEC" -m grpc_tools.protoc \
+  -I=proto \
+  --python_out=gen \
+  --grpc_python_out=gen \
+  proto/uns-gateway.proto
+
+  # Patch the generated _pb2_grpc.py to use relative imports
+GRPC_FILE="gen/uns_gateway_pb2_grpc.py"
+if [[ -f "$GRPC_FILE" ]]; then
+    echo "[setup] Patching $GRPC_FILE to use relative imports..."
+    if [[ "$PLATFORM" == "Linux" || "$PLATFORM" == "Darwin" ]]; then
+        sed -i 's/^import \(.*_pb2\) as/from . import \1 as/' "$GRPC_FILE"
+    elif [[ "$PLATFORM" =~ MINGW.*|MSYS.*|CYGWIN.* ]]; then
+        sed -i'' 's/^import \(.*_pb2\) as/from . import \1 as/' "$GRPC_FILE"
+    fi
+fi
+
+echo "[setup] Setup complete!"