remotivelabs-cli 0.0.32__tar.gz → 0.0.34__tar.gz

{remotivelabs_cli-0.0.32 → remotivelabs_cli-0.0.34}/PKG-INFO

@@ -1,15 +1,16 @@
 Metadata-Version: 2.1
 Name: remotivelabs-cli
-Version: 0.0.32
+Version: 0.0.34
 Summary: CLI for operating RemotiveCloud and RemotiveBroker
 Author: Johan Rask
 Author-email: johan.rask@remotivelabs.com
-Requires-Python: >=3.8,<3.12
+Requires-Python: >=3.8
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: grpc-stubs (>=1.53.0.5)
 Requires-Dist: mypy-protobuf (>=3.0.0)
 Requires-Dist: plotext (>=5.2,<6.0)

{remotivelabs_cli-0.0.32 → remotivelabs_cli-0.0.34}/cli/broker/lib/broker.py

@@ -18,6 +18,7 @@ import remotivelabs.broker.generated.sync.traffic_api_pb2 as traffic_api
 import remotivelabs.broker.sync as br
 import remotivelabs.broker.sync.helper as br_helper
 import typer
+from google.protobuf.json_format import MessageToDict
 from rich.console import Console
 
 from cli import settings
@@ -360,7 +361,7 @@ class Broker:
             namespaces.append(network_info.namespace.name)
         return namespaces
 
-    def list_signal_names(self) -> List[Dict[str, Any]]:
+    def list_signal_names(self, prefix: Union[str, None], suffix: Union[str, None]) -> List[Dict[str, Any]]:
         # Lists available signals
         configuration = self.system_stub.GetConfiguration(br.common_pb2.Empty())
 
@@ -368,30 +369,37 @@ class Broker:
         for network_info in configuration.networkInfo:
             res = self.system_stub.ListSignals(network_info.namespace)
             for finfo in res.frame:
-                # f: br.common_pb2.FrameInfo = finfo
-                receivers = []
-                for sinfo in finfo.childInfo:
-                    rec = list(map(lambda r: r, sinfo.metaData.receiver))
-                    receivers.extend(rec)
-                    signal_names.append(
-                        {
-                            "signal": sinfo.id.name,
-                            "namespace": network_info.namespace.name,
-                            "receivers": rec,
-                            "min": sinfo.metaData.min,
-                            "max": sinfo.metaData.max,
-                        }
+                if (prefix is None or finfo.signalInfo.id.name.startswith(prefix)) and (
+                    suffix is None or finfo.signalInfo.id.name.endswith(suffix)
+                ):
+                    metadata_dict = MessageToDict(
+                        finfo.signalInfo.metaData,
+                        including_default_value_fields=True,
+                        preserving_proto_field_name=True,
                     )
-
-                signal_names.append(
-                    {
+                    sig_dict = {
                         "signal": finfo.signalInfo.id.name,
                         "namespace": network_info.namespace.name,
-                        "senders": list(map(lambda s: s, finfo.signalInfo.metaData.sender)),
-                        "receivers": list(set(receivers)),
-                        "cycletime": finfo.signalInfo.metaData.cycleTime,
                     }
-                )
+                    signal_names.append({**sig_dict, **metadata_dict})
+
+                for sinfo in finfo.childInfo:
+                    # For signals we can simply skip if prefix and suffix exists does not match
+                    if (prefix is not None and not sinfo.id.name.startswith(prefix)) or (
+                        suffix is not None and not sinfo.id.name.endswith(suffix)
+                    ):
+                        continue
+
+                    metadata_dict = MessageToDict(
+                        sinfo.metaData,
+                        including_default_value_fields=True,
+                        preserving_proto_field_name=True,
+                    )
+                    sig_dict = {
+                        "signal": sinfo.id.name,
+                        "namespace": network_info.namespace.name,
+                    }
+                    signal_names.append({**sig_dict, **metadata_dict})
 
         return signal_names
 
@@ -433,7 +441,7 @@ class Broker:
         def find_subscribed_signal(available_signal: List[Dict[str, str]]) -> List[str]:
             return list(filter(lambda s: available_signal["signal"] == s, subscribed_signals))  # type: ignore
 
-        existing_signals = self.list_signal_names()
+        existing_signals = self.list_signal_names(prefix=None, suffix=None)
         existing_ns = set(map(lambda s: s["namespace"], existing_signals))
         ns_not_matching = []
         for ns in subscribed_namespaces:

{remotivelabs_cli-0.0.32 → remotivelabs_cli-0.0.34}/cli/broker/signals.py

@@ -5,7 +5,7 @@ import numbers
 import os
 import signal as os_signal
 from pathlib import Path
-from typing import Any, Dict, Iterable, List, TypedDict
+from typing import Any, Dict, Iterable, List, TypedDict, Union
 
 import grpc
 import plotext as plt  # type: ignore
@@ -30,23 +30,21 @@ class Signals(TypedDict):
 signal_values: Dict[Any, Any] = {}
 
 
-@app.command(name="list", help="List frame and signal metadata on broker")
+@app.command(name="list")
 def list_signals(
     url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
     api_key: str = typer.Option(None, help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
+    name_starts_with: Union[str, None] = typer.Option(None, help="Signal name prefix to include"),
+    name_ends_with: Union[str, None] = typer.Option(None, help="Signal name suffix to include"),
 ) -> None:
-    signal_names(url, api_key)
-
+    """
+    List signal metadata on a broker
 
-@app.command(help="List signals names on broker", deprecated=True)
-def signal_names(
-    url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
-    api_key: str = typer.Option(None, help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
-) -> None:
+    Filter are inclusive so --name-starts-with and --name-ends-with will include name that matches both
+    """
     try:
         broker = Broker(url, api_key)
-        # print("Listing available signals")
-        available_signals = broker.list_signal_names()
+        available_signals = broker.list_signal_names(prefix=name_starts_with, suffix=name_ends_with)
         print(json.dumps(available_signals))
     except grpc.RpcError as rpc_error:
         ErrorPrinter.print_grpc_error(rpc_error)

remotivelabs_cli-0.0.34/cli/cloud/auth/__init__.py

@@ -0,0 +1,3 @@
+from cli.cloud.auth.cmd import app
+
+__all__ = ["app"]

remotivelabs_cli-0.0.34/cli/cloud/auth/cmd.py

@@ -0,0 +1,46 @@
+import typer
+
+from cli import settings
+from cli.cloud.auth.login import login as do_login
+from cli.cloud.rest_helper import RestHelper as Rest
+
+from .. import auth_tokens
+
+HELP = """
+Manage how you authenticate with our cloud platform
+"""
+app = typer.Typer(help=HELP)
+app.add_typer(auth_tokens.app, name="tokens", help="Manage users personal access tokens")
+
+
+@app.command(name="login")
+def login() -> None:
+    """
+    Login to the cli using browser
+
+    This will be used as the current access token in all subsequent requests. This would
+    be the same as activating a personal access key or service-account access key.
+    """
+    do_login()
+
+
+@app.command()
+def whoami() -> None:
+    """
+    Validates authentication and fetches your user information
+    """
+    Rest.handle_get("/api/whoami")
+
+
+@app.command()
+def print_access_token() -> None:
+    """
+    Print current active access token
+    """
+    print(settings.read_secret_token())
+
+
+@app.command(help="Clear access token")
+def logout() -> None:
+    settings.clear_secret_token()
+    print("Access token removed")

remotivelabs_cli-0.0.32/cli/cloud/auth.py → remotivelabs_cli-0.0.34/cli/cloud/auth/login.py

@@ -4,23 +4,13 @@ from http.server import BaseHTTPRequestHandler, HTTPServer
 from threading import Thread
 from typing import Any
 
-import typer
 from typing_extensions import override
 
 from cli import settings
-
-from . import auth_tokens
-from .rest_helper import RestHelper as Rest
-
-HELP = """
-Manage how you authenticate with our cloud platform
-"""
+from cli.cloud.rest_helper import RestHelper as Rest
 
 httpd: HTTPServer
 
-app = typer.Typer(help=HELP)
-app.add_typer(auth_tokens.app, name="tokens", help="Manage users personal access tokens")
-
 
 class S(BaseHTTPRequestHandler):
     def _set_response(self) -> None:
@@ -55,46 +45,10 @@ def start_local_webserver(server_class: type = HTTPServer, handler_class: type =
     httpd = server_class(server_address, handler_class)
 
 
-#
-# CLI commands go here
-#
-
-
-@app.command(name="login")
 def login() -> None:
     """
-    Login to the cli using browser
-
-    This will be used as the current access token in all subsequent requests. This would
-    be the same as activating a personal access key or service-account access key.
+    Initiate login using browser
     """
     start_local_webserver()
-    webbrowser.open(
-        f"{Rest.get_base_url()}/login?redirectUrl=http://localhost:{httpd.server_address[1]}",
-        new=1,
-        autoraise=True,
-    )
-
+    webbrowser.open_new_tab(f"{Rest.get_base_url()}/login?redirectUrl=http://localhost:{httpd.server_address[1]}")
     httpd.serve_forever()
-
-
-@app.command()
-def whoami() -> None:
-    """
-    Validates authentication and fetches your user information
-    """
-    Rest.handle_get("/api/whoami")
-
-
-@app.command()
-def print_access_token() -> None:
-    """
-    Print current active access token
-    """
-    print(settings.read_secret_token())
-
-
-@app.command(help="Clear access token")
-def logout() -> None:
-    settings.clear_secret_token()
-    print("Access token removed")

{remotivelabs_cli-0.0.32 → remotivelabs_cli-0.0.34}/cli/cloud/cloud_cli.py

@@ -1,9 +1,8 @@
 import typer
 
+from cli.cloud import auth, brokers, configs, organisations, projects, recordings, sample_recordings, service_accounts, storage
 from cli.cloud.rest_helper import RestHelper
 
-from . import auth, brokers, configs, organisations, projects, recordings, sample_recordings, service_accounts, storage
-
 app = typer.Typer()
 
 

{remotivelabs_cli-0.0.32 → remotivelabs_cli-0.0.34}/cli/cloud/storage/cmd.py

@@ -10,15 +10,14 @@ from cli.cloud.storage.uri_or_path import UriOrPath
 from cli.cloud.storage.uri_or_path import uri as uri_parser
 from cli.errors import ErrorPrinter
 
-app = typer.Typer(
-    rich_markup_mode="rich",
-    help="""
+HELP = """
 Manage files ([yellow]Beta feature not available for all customers[/yellow])
 
 Copy file from local to remote storage and vice versa, list and delete files.
 
-""",
-)
+"""
+
+app = typer.Typer(rich_markup_mode="rich", help=HELP)
 
 
 @app.command(name="ls")

remotivelabs_cli-0.0.34/cli/cloud/storage/uri.py

@@ -0,0 +1,113 @@
+from __future__ import annotations
+
+from os import PathLike
+from pathlib import PurePosixPath
+from urllib.parse import urlparse
+
+
+class InvalidURIError(Exception):
+    """Raised when an invalid URI is encountered"""
+
+
+class JoinURIError(Exception):
+    """Raised when an error occurs while joining URIs"""
+
+
+class URI:
+    """
+    Custom type for rcs (Remotive Cloud Storage) URIs.
+
+    The URI format follows the pattern: rcs://bucket/path/to/resource
+    """
+
+    scheme: str
+    """The URI scheme (default: 'rcs')"""
+
+    path: str
+    """The full path component, including leading slash"""
+
+    filename: str
+    """The name of the file or last path segment"""
+
+    bucket: str
+    """The first path segment after the leading slash"""
+
+    parent: URI
+    """The parent URI. If at root, returns a copy of itself."""
+
+    def __init__(self, value: str, scheme: str = "rcs"):
+        """
+        Create a new URI.
+
+        Args:
+            value: The URI string in format "scheme://path/to/resource"
+            scheme: The URI scheme (default: 'rcs')
+
+        Raises:
+            InvalidURIError: If the URI format is invalid
+        """
+        self._raw = value
+        self.scheme = scheme
+
+        parsed = urlparse(value)
+        if parsed.scheme != self.scheme:
+            raise InvalidURIError(f"Invalid URI scheme. Expected '{self.scheme}://', got '{parsed.scheme}://'")
+        if parsed.netloc.startswith((".", "-", "#", " ", "/", "\\")):
+            raise InvalidURIError(f"Invalid URI. Path cannot start with invalid characters: '{value}'")
+        if not parsed.netloc and parsed.path == "/":
+            raise InvalidURIError(f"Invalid URI: '{value}'")
+
+        self.path = f"/{parsed.netloc}{parsed.path}" if parsed.netloc else f"/{parsed.path}"
+
+        self._posix_path = PurePosixPath(self.path)
+        self.filename = self._posix_path.name
+        self.bucket = self._posix_path.parts[1] if len(self._posix_path.parts) > 1 else ""
+
+        if self._posix_path == PurePosixPath("/"):
+            self.parent = self
+        else:
+            parent_path = self._posix_path.parent
+            new_uri = f"{self.scheme}://{str(parent_path)[1:]}"
+            self.parent = URI(new_uri, scheme=self.scheme)
+
+    def is_dir(self) -> bool:
+        """Check if the URI points to a directory."""
+        return self.path.endswith("/")
+
+    def __truediv__(self, other: PathLike[str] | str) -> URI:
+        """
+        Join this URI with another path component.
+
+        Args:
+            other: Path component to join
+
+        Returns:
+            A new URI with the joined path
+
+        Raises:
+            JoinURIError: If trying to join an absolute path
+            TypeError: If the path component is not a string or PathLike
+        """
+        if str(other).startswith("/"):
+            raise JoinURIError(f"Cannot join absolute path '{other}' to URI")
+
+        is_dir = str(other).endswith("/")
+        new_path = self._posix_path / other
+
+        for part in new_path.parts:
+            if part == "..":
+                new_path = new_path.parent
+            elif part != ".":
+                new_path = new_path / part
+
+        new_uri = f"{self.scheme}://{new_path.relative_to('/')}"  # we need to strip the starting '/'
+        new_uri = new_uri if not is_dir else f"{new_uri}/"  # and append slash if the added path was a dir
+        return URI(new_uri, scheme=self.scheme)
+
+    def __str__(self) -> str:
+        """Return the original URI string."""
+        return self._raw
+
+    def __repr__(self) -> str:
+        """Return the original URI string."""
+        return f"URI({self._raw})"

{remotivelabs_cli-0.0.32 → remotivelabs_cli-0.0.34}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "remotivelabs-cli"
-version = "0.0.32"
+version = "0.0.34"
 description = "CLI for operating RemotiveCloud and RemotiveBroker"
 authors = ["Johan Rask <johan.rask@remotivelabs.com>"]
 readme = "README.md"
@@ -11,8 +11,8 @@ packages = [{ include = "cli" }]
 remotive = "cli.remotive:app"
 
 [tool.poetry.dependencies]
+python = ">=3.8"
 trogon = ">=0.5.0"
-python = ">=3.8,<3.12"
 typer = "0.12.5"
 remotivelabs-broker = "~=0.1.17"
 rich = "~=13.7.0"
@@ -29,6 +29,8 @@ types-requests = "^2.32.0.20240622"
 [tool.poetry.group.test.dependencies]
 pytest = "^8.3"
 pytest-cov = "^5.0"
+semver = "^3.0.2"
+friendlywords = "^1.1.3"
 
 [tool.poetry.group.lint.dependencies]
 ruff = "^0.6.5"
@@ -36,14 +38,6 @@ pylint = "^3.2.7"
 pylint-protobuf = "^0.22.0"
 mypy = "^1.11"
 
-[tool.poe.tasks]
-test = [{ cmd = "pytest --cov=cli ." }]
-pylint = [{ cmd = "pylint ." }]
-lint = [{ cmd = "ruff check ." }, { cmd = "ruff format --check --diff ." }]
-format = [{ cmd = "ruff format ." }, { cmd = "ruff check --fix ." }]
-mypy = [{ cmd = "mypy -p cli" }]
-check = ["lint", "pylint", "mypy"]
-
 [tool.pytest.ini_options]
 markers = ["itests: run tests with custom flag"]
 
@@ -70,6 +64,7 @@ select = [
 recursive = true
 ignore-paths = '^.venv/.*$'
 load-plugins = ["pylint_protobuf"]
+ignored-modules = ["friendlywords"]
 
 [tool.pylint.format]
 max-line-length = 140
@@ -104,6 +99,9 @@ hide_error_codes = false
 module = "someip.*"
 ignore_missing_imports = true
 
+[[tool.mypy.overrides]]
+module = "friendlywords.*"
+ignore_missing_imports = true
 
 [build-system]
 requires = ["poetry-core"]

remotivelabs_cli-0.0.32/cli/cloud/storage/uri.py

@@ -1,59 +0,0 @@
-from __future__ import annotations
-
-from os import PathLike
-from pathlib import PurePosixPath
-from urllib.parse import urlparse
-
-
-class InvalidURIError(Exception):
-    """Raised when an invalid URI is encountered"""
-
-
-class JoinURIError(Exception):
-    """Raised when an error occurs while joining URIs"""
-
-
-class URI:
-    """
-    Custom type for rcs (Remotive Cloud Storage) URIs.
-    """
-
-    def __init__(self, value: str, scheme: str = "rcs"):
-        self.original_uri = value
-        self.scheme = scheme
-
-        parsed = urlparse(value)
-        if parsed.scheme != self.scheme:
-            raise InvalidURIError(f"Invalid URI scheme. Expected '{self.scheme}://', got '{parsed.scheme}://'")
-        if parsed.netloc.startswith((".", "-", "#", " ", "/", "\\")):
-            raise InvalidURIError(f"Invalid URI. Path cannot start with invalid characters: '{value}'")
-        if not parsed.netloc and parsed.path == "/":
-            raise InvalidURIError(f"Invalid URI: '{value}'")
-
-        self.path = f"/{parsed.netloc}{parsed.path}" if parsed.netloc else f"/{parsed.path}"
-
-        self._posix_path = PurePosixPath(self.path)
-        self.filename = self._posix_path.name
-
-    def is_dir(self) -> bool:
-        return self.path.endswith("/")
-
-    def __truediv__(self, other: PathLike[str] | str) -> URI:
-        """Returns a new URI object with the joined path"""
-        if str(other).startswith("/"):
-            raise JoinURIError(f"Cannot join absolute path '{other}' to URI")
-
-        new_path = self._posix_path / other
-
-        # handle relative paths
-        for part in new_path.parts:
-            if part == "..":
-                new_path = new_path.parent
-            elif part != ".":
-                new_path = new_path / part
-
-        new_uri = f"{self.scheme}://{new_path.relative_to('/')}"  # we need to strip the starting '/'
-        return URI(new_uri, scheme=self.scheme)
-
-    def __str__(self) -> str:
-        return self.original_uri