remotivelabs-cli 0.0.31__py3-none-any.whl → 0.0.33__py3-none-any.whl

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:

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)

cli/cloud/auth/__init__.py

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

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")

cli/cloud/{auth.py → 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")

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, filestorage, organisations, projects, recordings, sample_recordings, service_accounts
-
 app = typer.Typer()
 
 
@@ -21,7 +20,7 @@ app.add_typer(auth.app, name="auth")
 app.add_typer(brokers.app, name="brokers", help="Manage cloud broker lifecycle")
 app.add_typer(recordings.app, name="recordings", help="Manage recordings")
 app.add_typer(configs.app, name="signal-databases", help="Manage signal databases")
-app.add_typer(filestorage.app, name="storage")
+app.add_typer(storage.app, name="storage")
 app.add_typer(service_accounts.app, name="service-accounts", help="Manage project service account keys")
 app.add_typer(sample_recordings.app, name="samples", help="Manage sample recordings")
 

cli/cloud/configs.py

@@ -48,10 +48,14 @@ def upload(
     """
     Uploads signal database to project
     """
-    res = Rest.handle_put(url=f"/api/project/{project}/files/config/{os.path.basename(path)}/uploadfile", return_response=True)
-    if res is not None:
+    res_text = Rest.handle_put(url=f"/api/project/{project}/files/config/{os.path.basename(path)}/uploadfile", return_response=True)
+    if res_text is not None:
+        res_json = res_text.json()
         Rest.upload_file_with_signed_url(
-            path=path, url=res.text, upload_headers={"Content-Type": "application/octet-stream"}, progress_label=f"Uploading {path}..."
+            path=path,
+            url=res_json["url"],
+            upload_headers={"Content-Type": "application/octet-stream"},
+            progress_label=f"Uploading {path}...",
         )
 
 

cli/cloud/recordings.py

@@ -9,7 +9,7 @@ import tempfile
 import time
 import urllib.parse
 from pathlib import Path
-from typing import Any, Dict, List, Tuple, Union
+from typing import Any, Dict, List, Optional, Tuple, Union
 from urllib.parse import quote
 
 import grpc
@@ -119,12 +119,10 @@ def __check_rcs_path(path: str) -> str:
 
 
 def do_start(name: str, project: str, api_key: str, return_response: bool = False) -> requests.Response:
-    if api_key == "":
-        body = {"size": "S"}
-    else:
-        body = {"size": "S", "apiKey": api_key}
+    body = {"size": "S"}
+    if not api_key:
+        body["apiKey"] = api_key
 
-    name = name if name is not None else "personal"
     return Rest.handle_post(
         f"/api/project/{project}/brokers/{name}",
         body=json.dumps(body),
@@ -136,7 +134,7 @@ def do_start(name: str, project: str, api_key: str, return_response: bool = Fals
 @app.command(help="Prepares all recording files and transformations to be available for playback")
 def mount(  # noqa: C901
     recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
-    broker: str = typer.Option(None, help="Broker to use"),
+    broker: Optional[str] = typer.Option(None, help="Broker to use"),
     ensure_broker_started: bool = typer.Option(default=False, help="Ensure broker exists, start otherwise"),
     transformation_name: str = typer.Option("default", help="Specify a custom signal transformation to use"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
@@ -153,7 +151,7 @@ def mount(  # noqa: C901
             broker = r.json()["shortName"]
 
         elif r.status_code == 404:
-            r = do_start(None, project, "", return_response=True)
+            r = do_start("personal", project, "", return_response=True)
             if r.status_code != 200:
                 print(r.text)
                 sys.exit(0)
@@ -208,7 +206,7 @@ def download_recording_file(
     )
     if get_signed_url_resp.status_code == 200:
         # Next download the actual file
-        Rest.download_file(recording_file_name, get_signed_url_resp.json()["downloadUrl"])
+        Rest.download_file(Path(recording_file_name), get_signed_url_resp.json()["downloadUrl"])
         print(f"Downloaded {recording_file_name}")
     else:
         print(get_signed_url_resp)

cli/cloud/rest_helper.py

@@ -250,7 +250,7 @@ class RestHelper:
         return p
 
     @staticmethod
-    def download_file(save_file_name: str, url: str) -> None:
+    def download_file(save_file_name: Path, url: str) -> None:
         # Next download the actual file
         download_resp = requests.get(url=url, stream=True, timeout=60)
         if download_resp.status_code == 200:

cli/cloud/resumable_upload.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import os
 import sys
+from pathlib import Path
 from typing import Dict
 
 import requests
@@ -66,7 +67,7 @@ def with_resumable_upload_signed_url(signed_url: str, source_file_name: str, con
     print(f"File {source_file_name} uploaded successfully.")
 
 
-def upload_signed_url(signed_url: str, source_file_name: str, headers: Dict[str, str]) -> None:
+def upload_signed_url(signed_url: str, source_file_name: Path, headers: Dict[str, str]) -> None:
     """
     Upload file to file storage with signed url and resumable upload.
     Resumable upload will only work with the same URL and not if a new signed URL is requested with the
@@ -76,7 +77,6 @@ def upload_signed_url(signed_url: str, source_file_name: str, headers: Dict[str,
     :param source_file_name:
     :return:
     """
-
     with open(source_file_name, "rb") as file:
         with wrap_file(file, os.stat(source_file_name).st_size, description=f"Uploading {source_file_name}...") as f:
             response = requests.put(signed_url, headers=headers, timeout=60, data=f)

cli/cloud/storage/__init__.py

@@ -0,0 +1,5 @@
+from cli.cloud.storage.cmd import app
+from cli.cloud.storage.uri import URI
+from cli.cloud.storage.uri_or_path import UriOrPath
+
+__all__ = ["URI", "UriOrPath", "app"]

cli/cloud/storage/cmd.py

@@ -0,0 +1,76 @@
+import sys
+
+import typer
+from typing_extensions import Annotated
+
+from cli.cloud.rest_helper import RestHelper as Rest
+from cli.cloud.storage.copy import copy
+from cli.cloud.storage.uri import URI, InvalidURIError, JoinURIError
+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
+
+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")
+def list_files(
+    project: Annotated[str, typer.Option(help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT", show_default=False)],
+    uri: Annotated[URI, typer.Argument(help="Remote storage path", parser=URI)] = "rcs://",  # type: ignore
+) -> None:
+    """
+    Listing remote files
+
+    This will list files and directories in project top level directory
+    remotive cloud storage ls rcs://
+
+    This will list all files and directories matching the path
+    remotive cloud storage ls rcs://fileOrDirectoryPrefix
+
+    This will list all files and directories in the specified directory
+    remotive cloud storage ls rcs://fileOrDirectory/
+    """
+    Rest.handle_get(f"/api/project/{project}/files/storage{uri.path}")
+
+
+@app.command(name="rm")
+def delete_file(
+    project: Annotated[str, typer.Option(help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT", show_default=False)],
+    uri: Annotated[URI, typer.Argument(help="Remote storage path", parser=URI, show_default=False)],
+) -> None:
+    """
+    [red]Deletes[/red] a file from remote storage, this cannot be undone :fire:
+
+    [white]remotive cloud storage rm rcs://directory/filename[/white]
+    """
+    Rest.handle_delete(f"/api/project/{project}/files/storage{uri.path}")
+
+
+@app.command(name="cp")
+def copy_file(
+    project: Annotated[str, typer.Option(help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT", show_default=False)],
+    source: Annotated[UriOrPath, typer.Argument(help="Remote or local path to source file", parser=uri_parser, show_default=False)],
+    dest: Annotated[UriOrPath, typer.Argument(help="Remote or local path to destination file", parser=uri_parser, show_default=False)],
+    overwrite: Annotated[bool, typer.Option(help="Overwrite existing file on RCS")] = False,
+) -> None:
+    """
+    Copies a file to or from remote storage
+
+    remotive cloud storage cp rcs://dir/filename .
+    remotive cloud storage cp rcs://dir/filename filename
+
+    remotive cloud storage cp filename rcs://dir/
+    remotive cloud storage cp filename rcs://dir/filename
+    """
+    try:
+        return copy(project=project, source=source.value, dest=dest.value, overwrite=overwrite)
+    except (InvalidURIError, JoinURIError, ValueError, FileNotFoundError, FileExistsError) as e:
+        ErrorPrinter.print_hint(str(e))
+        sys.exit(1)

cli/cloud/storage/copy.py

@@ -0,0 +1,86 @@
+from __future__ import annotations
+
+import json
+from pathlib import Path
+
+from cli.cloud.rest_helper import RestHelper as Rest
+from cli.cloud.resumable_upload import upload_signed_url
+from cli.cloud.storage.uri import URI
+
+_RCS_STORAGE_PATH = "/api/project/{project}/files/storage{path}"
+
+
+def copy(project: str, source: URI | Path, dest: URI | Path, overwrite: bool = False) -> None:
+    if isinstance(source, Path) and isinstance(dest, Path):
+        raise ValueError("Either source or destination must be an rcs:// uri")
+
+    if isinstance(source, URI) and isinstance(dest, URI):
+        raise ValueError("Either source or destination must be a local path")
+
+    if isinstance(source, URI) and isinstance(dest, Path):
+        _download(source=source, dest=dest, project=project, overwrite=overwrite)
+
+    elif isinstance(source, Path) and isinstance(dest, URI):
+        _upload(source=source, dest=dest, project=project, overwrite=overwrite)
+
+    else:
+        raise ValueError("invalid copy operation")
+
+
+def _upload(source: Path, dest: URI, project: str, overwrite: bool = False) -> None:
+    if not source.exists():
+        raise FileNotFoundError(source)
+
+    files_to_upload = _list_files_for_upload(source, dest)
+
+    for file_path, target_uri in files_to_upload:
+        _upload_single_file(file_path, target_uri, project, overwrite)
+
+
+def _list_files_for_upload(source: Path, dest: URI) -> list[tuple[Path, URI]]:
+    upload_pairs = []
+
+    if source.is_dir():
+        for file_path in source.rglob("*"):
+            if file_path.is_file():
+                relative_path = file_path.relative_to(source)
+                target_uri = dest / relative_path
+                upload_pairs.append((file_path, target_uri))
+    else:
+        target_uri = dest / source.name if dest.is_dir() else dest
+        upload_pairs.append((source, target_uri))
+
+    return upload_pairs
+
+
+def _upload_single_file(source: Path, target_uri: URI, project: str, overwrite: bool = False) -> None:
+    target = _RCS_STORAGE_PATH.format(project=project, path=target_uri.path)
+    upload_options = {"overwrite": "always" if overwrite else "never"}
+    res = Rest.handle_post(target, return_response=True, body=json.dumps(upload_options))
+
+    json_res = res.json()
+    url = json_res["url"]
+    headers = json_res["headers"]
+    upload_signed_url(url, source, headers)
+
+    print(f"Uploaded {source} to {target_uri.path}")
+
+
+def _download(source: URI, dest: Path, project: str, overwrite: bool = False) -> None:
+    if dest.is_dir():
+        if not dest.exists():
+            raise FileNotFoundError(f"Destination directory {dest} does not exist")
+        # create a target file name if destination is a dir
+        dest = dest / source.filename
+
+    else:
+        if not dest.parent.is_dir() or not dest.parent.exists():
+            raise FileNotFoundError(f"Destination directory {dest.parent} does not exist")
+
+    if dest.exists() and not overwrite:
+        raise FileExistsError(f"Destination file {dest} already exists")
+
+    target = _RCS_STORAGE_PATH.format(project=project, path=source.path) + "?download=true"
+    res = Rest.handle_get(target, return_response=True)
+
+    Rest.download_file(save_file_name=dest.absolute(), url=res.text)

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})"

cli/cloud/storage/uri_or_path.py

@@ -0,0 +1,45 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+from cli.cloud.storage.uri import URI, InvalidURIError
+
+
+def uri(path: str) -> UriOrPath:
+    """
+    Parses a path and returns a UriOrPath object.
+
+    NOTE: The name of this function is important as it is used by Typer to determine the name/type of the argument
+    """
+    try:
+        p: Path | URI = URI(path)
+    except InvalidURIError:
+        p = Path(path)
+    return UriOrPath(p)
+
+
+class UriOrPath:
+    """
+    Union type for handling local and remote paths for Remotive Cloud Storage
+
+    Note: This custom type only exists because Typer currently does not support union types
+    TODO: Move to commands package when refactored
+    """
+
+    def __init__(self, value: Path | URI) -> None:
+        self._value = value
+
+    @property
+    def uri(self) -> URI | None:
+        return self._value if isinstance(self._value, URI) else None
+
+    @property
+    def path(self) -> Path | None:
+        return self._value if isinstance(self._value, Path) else None
+
+    @property
+    def value(self) -> Path | URI:
+        return self._value
+
+    def __str__(self) -> str:
+        return str(self._value)

{remotivelabs_cli-0.0.31.dist-info → remotivelabs_cli-0.0.33.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: remotivelabs-cli
-Version: 0.0.31
+Version: 0.0.33
 Summary: CLI for operating RemotiveCloud and RemotiveBroker
 Author: Johan Rask
 Author-email: johan.rask@remotivelabs.com
@@ -19,7 +19,7 @@ Requires-Dist: python-socketio (>=4.6.1)
 Requires-Dist: remotivelabs-broker (>=0.1.17,<0.2.0)
 Requires-Dist: rich (>=13.7.0,<13.8.0)
 Requires-Dist: trogon (>=0.5.0)
-Requires-Dist: typer (>=0.9.0,<0.10.0)
+Requires-Dist: typer (==0.12.5)
 Requires-Dist: types-requests (>=2.32.0.20240622,<3.0.0.0)
 Requires-Dist: websocket-client (>=1.6,<2.0)
 Requires-Dist: zeroconf (>=0.127.0,<0.128.0)

{remotivelabs_cli-0.0.31.dist-info → remotivelabs_cli-0.0.33.dist-info}/RECORD

@@ -3,29 +3,35 @@ cli/broker/brokers.py,sha256=oUadEL6xQ4bhXucBH-ZjL67VuERf19kn1g240v_lEpg,3197
 cli/broker/export.py,sha256=3sG9i6ZwOQW6snu87NSzOL2_giQTYQMzQlpPg7z8n78,4431
 cli/broker/files.py,sha256=_MVwitQ5Z9-lNDb3biXqnlkKti8rizTEw0nnAViussU,4181
 cli/broker/lib/__about__.py,sha256=xnZ5V6ZcHW9dhWLWdMzVjYJbEnMKpeXm0_S_mbNzypE,141
-cli/broker/lib/broker.py,sha256=iBv-uegVD6awnhkukV50CcZywIybEO3qvI0YU47KcGo,23949
+cli/broker/lib/broker.py,sha256=Ip9Fg3WskADWjaIO-315s0vCMtZxM5jwBFpK0QuuIPI,24515
 cli/broker/license_flows.py,sha256=qJplaeugkUiypFGPdEIl5Asqlf7W3geJ-wU-QbYMP_8,7216
 cli/broker/licenses.py,sha256=Ddl243re8RoeP9CoWWbIzwDePQ9l8r7ixmbd1gqn8f0,3973
 cli/broker/playback.py,sha256=hdDKXGPuIE3gcT-kgQltgn5jsPzK19Yh9hiNcgtkLX0,3992
 cli/broker/record.py,sha256=Oa6hUpS0Dgnt0f6Ig33vl0Jy8wN7wMXfemaxXWjRVoQ,1414
 cli/broker/scripting.py,sha256=8577_C6siOk90s4G1ItIfAoFIUAkS0ItUl5kqR0cD-k,3792
-cli/broker/signals.py,sha256=llok_jUGWOzAiiQUK54uRDnDuonBOAYBDbPdnzCFdog,7075
+cli/broker/signals.py,sha256=KflNaVFgsKFi1suec7fSkCfGhcJ0LfPTMRGVQUlsU-0,7058
 cli/cloud/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cli/cloud/auth.py,sha256=RBTDUGRBVsK28u-aeqzRIzHnW7FqH4KADlVlQEgBCww,2534
+cli/cloud/auth/__init__.py,sha256=MtQ01-n8CgZb9Y_SvxwZUgj44Yo0dFAU3_XwhQiUYtw,54
+cli/cloud/auth/cmd.py,sha256=T2o-T3KYQPZU5Ujj7IuOYA7icbv930hks14YA-4Gh1s,1077
+cli/cloud/auth/login.py,sha256=yhehYM97tcS6A7srVU4Olg8s58H0JJzfSl7yWp9a1VI,1607
 cli/cloud/auth_tokens.py,sha256=0U60Gk2-TnAUff5anZmTB1rOEninNvYy1o5ihCqgj8A,4525
 cli/cloud/brokers.py,sha256=DNj79MTkPylKUQbr-iPUhQgfNJLAW8UehnvgpEmNH_k,3890
-cli/cloud/cloud_cli.py,sha256=09YCHs8IivYsVJOsxlM5OMEqBdq3QUXtDsktcO8Kjyw,1263
-cli/cloud/configs.py,sha256=xg3J-kaS-Pp0p9otV2cWl_oOWJzs_jZhXwFHz0gQxvc,4625
-cli/cloud/filestorage.py,sha256=BZbSk9abuLYw9TjGsQpfYMobtE4VLgXFrWD1sVvGolY,5621
+cli/cloud/cloud_cli.py,sha256=c_JMjAOsJnAw4TM7gkPWmEfrrQly6lAppvfHAmaUGmo,1262
+cli/cloud/configs.py,sha256=bZzZF-yNkZkfJK5baU0Xh_vQRrJkmuzEv8xx4_IkXZ8,4714
 cli/cloud/organisations.py,sha256=txKQmSQEpTmeqlqngai8pwgQQEvRgeDd0dT_VzZ7RNc,752
 cli/cloud/projects.py,sha256=YrwPJClC2Sq_y1HjPd_tzaiv4GEnnsXSXHBhtQCPdK0,1431
-cli/cloud/recordings.py,sha256=jai5Gim28UmZFGniUI9qKDwtLoi2Nllv4eyPeIk3OAc,25366
+cli/cloud/recordings.py,sha256=RK-CfYEZ_K4o_nOuRBQ6JCsNpTc8yGWQUMV_BN4aWQA,25315
 cli/cloud/recordings_playback.py,sha256=PRzftmvG2iePrL9f6qTEXVOnyJ-etcyzn5w9CCxcSto,11539
-cli/cloud/rest_helper.py,sha256=lZp0NjQ8yOaggQGNiqNxHex_YFOmuq0rnLPtpLq3Z3Q,11470
-cli/cloud/resumable_upload.py,sha256=5R6TLq9j8h-qs5bgGFC-lVaEsTI4DoAiTsZcROVtqgw,3688
+cli/cloud/rest_helper.py,sha256=_3RLk8C101PH5pCq5GhCCYLSiS2TZtXh69Yt5TfiJsY,11471
+cli/cloud/resumable_upload.py,sha256=8lEIdncJZoTZzNsQVHH3gm_GunxEmN5JbmWX7awy3p4,3713
 cli/cloud/sample_recordings.py,sha256=OVX32U1dkkkJZysbgr5Dy515oOQKnwBAbZYzV_QUu1g,690
 cli/cloud/service_account_tokens.py,sha256=263u1bRmBKfYsxL6TV6YjReUBUaVHWc3ETCd7AS3DTU,2297
 cli/cloud/service_accounts.py,sha256=XOIPobUamCLIaufjyvb33XJDwy6uRqW5ZljZx3GYEfo,1659
+cli/cloud/storage/__init__.py,sha256=y6V0QswTVY7lHcy5kVUbNKIPc5tyWDqvhakcRFKV6HA,167
+cli/cloud/storage/cmd.py,sha256=Uq8tRJw9AYD8V4F5SeqUGKGfAZRdB-J3vHDdCbhfhCg,2931
+cli/cloud/storage/copy.py,sha256=thjdhqnFHSstsA5Iidz74c2o4zHfEaDXfRUGOpjWh1o,3228
+cli/cloud/storage/uri.py,sha256=QZCus--KJQlVwGCOzZqiglvj8VvSRKxfVvN33Pilgyg,3616
+cli/cloud/storage/uri_or_path.py,sha256=rTjg9G0h8-jb4QUlza1YMqqs99ifrydnEL7o7rmidKQ,1166
 cli/connect/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cli/connect/connect.py,sha256=U--6dtHxUlvE81J37rABFez4TbF7AXWOpZYZnL7sPMY,3994
 cli/connect/protopie/protopie.py,sha256=KBMbBwdkUVgV2X7AXTHweVqYVHv4akG875FVc36gsyg,6349
@@ -33,11 +39,12 @@ cli/errors.py,sha256=CXYArw1W82bRFwJkJ3tD-Ek1huKeah502DGMvPxHYFo,1366
 cli/remotive.py,sha256=z834JeOwENyUM4bS74_zE95sGwu1efgfDVtCLKV5rV0,1789
 cli/settings.py,sha256=A5rtp_1oix7Com5aHCAHdwJqxoV2LgxpYXwCe40v7oY,2072
 cli/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cli/tools/can/RemotiveLabs.can1.log,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cli/tools/can/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cli/tools/can/can.py,sha256=8uATViSFlpkdSiIm4fzbuQi1_m7V9Pym-K17TaJQRHU,2262
 cli/tools/tools.py,sha256=0KU-hXR1f9xHP4BOG9A9eXfmICLmNuQCOU8ueF6iGg0,198
-remotivelabs_cli-0.0.31.dist-info/LICENSE,sha256=qDPP_yfuv1fF-u7EfexN-cN3M8aFgGVndGhGLovLKz0,608
-remotivelabs_cli-0.0.31.dist-info/METADATA,sha256=hXSuC1H53XacGz8LX3D4ySgdUIOncQG7iIWQEm5NdkI,1318
-remotivelabs_cli-0.0.31.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-remotivelabs_cli-0.0.31.dist-info/entry_points.txt,sha256=lvDhPgagLqW_KTnLPCwKSqfYlEp-1uYVosRiPjsVj10,45
-remotivelabs_cli-0.0.31.dist-info/RECORD,,
+remotivelabs_cli-0.0.33.dist-info/LICENSE,sha256=qDPP_yfuv1fF-u7EfexN-cN3M8aFgGVndGhGLovLKz0,608
+remotivelabs_cli-0.0.33.dist-info/METADATA,sha256=i6JbcH5fZlS-46mb2wqWF4xCpERjMpkGLL57IPXrUcI,1311
+remotivelabs_cli-0.0.33.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+remotivelabs_cli-0.0.33.dist-info/entry_points.txt,sha256=lvDhPgagLqW_KTnLPCwKSqfYlEp-1uYVosRiPjsVj10,45
+remotivelabs_cli-0.0.33.dist-info/RECORD,,

cli/cloud/filestorage.py

@@ -1,170 +0,0 @@
-from __future__ import annotations
-
-import json
-import os.path
-import sys
-from pathlib import Path
-
-import typer
-
-from ..errors import ErrorPrinter
-from . import resumable_upload as upload
-from .rest_helper import RestHelper as Rest
-
-app = typer.Typer(
-    rich_markup_mode="rich",
-    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.command(name="ls")
-def list_files(
-    project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
-    prefix: str = typer.Argument(default="rcs://", help="Remote storage path"),
-) -> None:
-    """
-    Listing remote files
-
-    This will list files and directories in project top level directory
-    remotive cloud storage ls rcs://
-
-    This will list all files and directories matching the path
-    remotive cloud storage ls rcs://fileOrDirectoryPrefix
-
-    This will list all files and directories in the specified directory
-    remotive cloud storage ls rcs://fileOrDirectory/
-    """
-
-    if prefix.startswith("rcs://"):
-        prefix = __check_rcs_path(prefix)
-    else:
-        ErrorPrinter.print_hint("Path must start with rcs://")
-        sys.exit(1)
-
-    Rest.handle_get(
-        f"/api/project/{project}/files/storage{prefix}",
-    )
-
-
-@app.command(name="rm")
-def delete_file(
-    project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
-    path: str = typer.Argument(default=..., help="Remote storage path to file to delete"),
-) -> None:
-    """
-    [red]Deletes[/red] a file from remote storage, this cannot be undone :fire:
-
-    [white]remotive cloud storage rm rcs://directory/filename[/white]
-    """
-    if path.startswith("rcs://"):
-        prefix = __check_rcs_path(path)
-    else:
-        ErrorPrinter.print_hint("Path must start with rcs://")
-        sys.exit(1)
-
-    Rest.handle_delete(
-        f"/api/project/{project}/files/storage{prefix}",
-    )
-
-
-@app.command(name="cp")
-def copy_file(  # noqa: C901 # type: ignore[too-many-branches]  # pylint: disable=no-member
-    source: str = typer.Argument(default=..., help="Remote or local path to source file"),
-    dest: str = typer.Argument(default=..., help="Remote or local path to destination file"),
-    overwrite: bool = typer.Option(default=False, help="Overwrite existing file on RCS"),
-    project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
-) -> None:
-    """
-    Copies a file to or from remote storage
-
-    remotive cloud storage cp rcs://dir/filename .
-    remotive cloud storage cp rcs://dir/filename filename
-
-    remotive cloud storage cp filename rcs://dir/
-    remotive cloud storage cp filename rcs://dir/filename
-    """
-
-    if not source.startswith("rcs://") and not dest.startswith("rcs://"):
-        ErrorPrinter.print_hint("Source or destination path must be an rcs:// path")
-        sys.exit(2)
-
-    if source.startswith("rcs://") and dest.startswith("rcs://"):
-        ErrorPrinter.print_hint("Currently one of source and destination path must be a local path")
-        sys.exit(2)
-
-    if source.startswith("rcs://"):
-        __copy_to_local(source=source, dest=dest, project=project)
-    else:
-        path = Path(source)
-        if path.is_dir():
-            for file_path in path.rglob("*"):
-                if file_path.is_file():
-                    __copy_to_remote(source=source, dest=dest, project=project, overwrite=overwrite)
-            sys.exit(1)
-        else:
-            __copy_to_remote(source=source, dest=dest, project=project, overwrite=overwrite)
-
-
-def __copy_to_remote(source: str, dest: str, project: str, overwrite: bool) -> None:
-    path = Path(source)
-    if path.is_dir():
-        sys.exit(1)
-
-    if not path.exists():
-        ErrorPrinter.print_hint("Source file does not exist")
-        sys.exit(1)
-    filename = source.rsplit("/", 1)[-1]
-    rcs_path = __check_rcs_path(dest)
-    if rcs_path.endswith("/"):
-        rcs_path = rcs_path + filename
-    upload_options = {"overwrite": "always" if overwrite else "never"}
-    res = Rest.handle_post(f"/api/project/{project}/files/storage{rcs_path}", return_response=True, body=json.dumps(upload_options))
-    if res is None:
-        return
-    json_res = res.json()
-    url = json_res["url"]
-    headers = json_res["headers"]
-    try:
-        upload.upload_signed_url(url, source, headers)
-    except IsADirectoryError:
-        ErrorPrinter.print_hint(f"Supplied source file '{source}' is a directory but must be a file")
-
-
-def __copy_to_local(source: str, dest: str, project: str) -> None:
-    rcs_path = __check_rcs_path(source)
-    filename = source.rsplit("/", 1)[-1]
-    path = Path(dest)
-    if path.is_dir():
-        if not path.exists():
-            ErrorPrinter.print_generic_error("Destination directory does not exist")
-            sys.exit(1)
-        else:
-            dest = os.path.join(path.absolute(), filename)
-
-    else:
-        if not path.parent.is_dir() or not path.parent.exists():
-            ErrorPrinter.print_generic_error("Destination directory does not exist")
-            sys.exit(1)
-    dest = str(Path(dest).absolute())
-
-    res = Rest.handle_get(
-        f"/api/project/{project}/files/storage{rcs_path}?download=true",
-        return_response=True,
-    )
-    if res is None:
-        return
-
-    Rest.download_file(save_file_name=dest, url=res.text)
-
-
-def __check_rcs_path(path: str) -> str:
-    rcs_path = path.replace("rcs://", "/")
-    if rcs_path.startswith("/."):
-        ErrorPrinter.print_hint("Invalid path")
-        sys.exit(1)
-    return rcs_path