remotivelabs-cli 0.0.26__tar.gz → 0.0.27__tar.gz

{remotivelabs_cli-0.0.26 → remotivelabs_cli-0.0.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: remotivelabs-cli
-Version: 0.0.26
+Version: 0.0.27
 Summary: CLI for operating RemotiveCloud and RemotiveBroker
 Author: Johan Rask
 Author-email: johan.rask@remotivelabs.com

{remotivelabs_cli-0.0.26 → remotivelabs_cli-0.0.27}/cli/broker/lib/broker.py

@@ -360,7 +360,7 @@ class Broker:
             namespaces.append(network_info.namespace.name)
         return namespaces
 
-    def list_signal_names(self) -> List[Dict[str, str]]:
+    def list_signal_names(self) -> List[Dict[str, Any]]:
         # Lists available signals
         configuration = self.system_stub.GetConfiguration(br.common_pb2.Empty())
 
@@ -369,9 +369,30 @@ class Broker:
             res = self.system_stub.ListSignals(network_info.namespace)
             for finfo in res.frame:
                 # f: br.common_pb2.FrameInfo = finfo
-                signal_names.append({"signal": finfo.signalInfo.id.name, "namespace": network_info.namespace.name})
+                receivers = []
                 for sinfo in finfo.childInfo:
-                    signal_names.append({"signal": sinfo.id.name, "namespace": network_info.namespace.name})
+                    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,
+                        }
+                    )
+
+                signal_names.append(
+                    {
+                        "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,
+                    }
+                )
+
         return signal_names
 
     def subscribe_on_script(

{remotivelabs_cli-0.0.26 → remotivelabs_cli-0.0.27}/cli/broker/signals.py

@@ -30,7 +30,15 @@ class Signals(TypedDict):
 signal_values: Dict[Any, Any] = {}
 
 
-@app.command(help="List signals names on broker")
+@app.command(name="list", help="List frame and signal metadata on broker")
+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"),
+) -> None:
+    signal_names(url, api_key)
+
+
+@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"),

{remotivelabs_cli-0.0.26 → remotivelabs_cli-0.0.27}/cli/cloud/auth_tokens.py

@@ -1,6 +1,7 @@
 import json
 import os
 import sys
+from json.decoder import JSONDecodeError
 from pathlib import Path
 
 import typer
@@ -42,14 +43,37 @@ def list_personal_access_tokens() -> None:
     Rest.handle_get("/api/me/keys")
 
 
-@app.command(name="revoke", help="Revoke the specified access token")
-def revoke(name: str = typer.Option(..., help="Name of the access token to revoke")) -> None:
+@app.command(name="revoke")
+def revoke(name_or_file: str = typer.Argument(help="Name or file path of the access token to revoke")) -> None:
+    """
+        Revoke an access token by token name or path to a file containing that token
+
+        Name is found in the json file
+
+        {
+            "expires": "2034-07-31",
+            "token": "xxx",
+            "created": "2024-07-31T09:18:50.406+02:00",
+            "name": "token_name"
+    }
+    """
+    name = name_or_file
+    if "." in name_or_file:
+        json_str = read_file(name_or_file)
+        try:
+            name = json.loads(json_str)["name"]
+        except JSONDecodeError:
+            sys.stderr.write("Failed to parse json, make sure its a correct access token file\n")
+            sys.exit(1)
+        except KeyError:
+            sys.stderr.write("Json does not contain a name property, make sure its a correct access token file\n")
+            sys.exit(1)
     Rest.ensure_auth_token()
     Rest.handle_delete(f"/api/me/keys/{name}")
 
 
 @app.command()
-def describe(file: str = typer.Option(..., help="File name")) -> None:
+def describe(file: str = typer.Argument(help="File name")) -> None:
     """
     Show contents of specified access token file
     """
@@ -92,7 +116,16 @@ def list_files() -> None:
 
 
 def read_file(file: str) -> str:
-    with open(str(Path.home()) + f"/.config/.remotive/{file}", "r", encoding="utf8") as f:
+    """
+    Reads a file using file path or if that does not exist check under ~/.config/.remotive
+    """
+    path = file
+    if not Path(file).exists():
+        path = str(Path.home()) + f"/.config/.remotive/{file}"
+        if not Path(path).exists():
+            sys.stderr.write(f"Failed to find file using {file} or {path}\n")
+            sys.exit(1)
+    with open(path, "r", encoding="utf8") as f:
         token = f.read()
         f.close()
         return token

{remotivelabs_cli-0.0.26 → remotivelabs_cli-0.0.27}/cli/cloud/cloud_cli.py

@@ -1,10 +1,8 @@
-import json
-
 import typer
 
 from cli.cloud.rest_helper import RestHelper
 
-from . import auth, brokers, configs, filestorage, projects, recordings, sample_recordings, service_accounts
+from . import auth, brokers, configs, filestorage, organisations, projects, recordings, sample_recordings, service_accounts
 
 app = typer.Typer()
 
@@ -17,19 +15,7 @@ def licenses(
     RestHelper.handle_get(f"/api/bu/{organisation}/licenses", {"filter": filter_option})
 
 
-@app.command(help="List your available organisations")
-def organisations() -> None:
-    r = RestHelper.handle_get("/api/home", return_response=True)
-    if r is None:
-        return
-    if r.status_code == 200:
-        j = list(map(lambda x: x["billableUnitUser"]["billableUnit"]["uid"], r.json()))
-        print(json.dumps(j))
-    else:
-        print(f"Got status code: {r.status_code}")
-        print(r.text)
-
-
+app.add_typer(organisations.app, name="organisations", help="Manage organisations")
 app.add_typer(projects.app, name="projects", help="Manage projects")
 app.add_typer(auth.app, name="auth")
 app.add_typer(brokers.app, name="brokers", help="Manage cloud broker lifecycle")

{remotivelabs_cli-0.0.26 → remotivelabs_cli-0.0.27}/cli/cloud/configs.py

@@ -14,6 +14,9 @@ app = typer.Typer()
 
 @app.command("list")
 def list_signal_databases(project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")) -> None:
+    """
+    List available signal databases in project
+    """
     Rest.handle_get(f"/api/project/{project}/files/config")
 
 
@@ -22,6 +25,9 @@ def delete(
     signal_db_file: str = typer.Argument("", help="Signal database file"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
 ) -> None:
+    """
+    Deletes the specified signal database
+    """
     Rest.handle_delete(f"/api/project/{project}/files/config/{signal_db_file}")
 
 
@@ -54,6 +60,9 @@ def download(
     signal_db_file: str = typer.Argument("", help="Signal database file"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
 ) -> None:
+    """
+    Downloads the specified signal database to disk
+    """
     with Progress(
         SpinnerColumn(),
         TextColumn("[progress.description]{task.description}"),

remotivelabs_cli-0.0.27/cli/cloud/organisations.py

@@ -0,0 +1,30 @@
+import json
+import sys
+
+import typer
+
+from cli.cloud.rest_helper import RestHelper
+
+app = typer.Typer()
+
+
+@app.command(name="list", help="List your available organisations")
+def list_orgs() -> None:
+    r = RestHelper.handle_get("/api/home", return_response=True)
+    if r is None:
+        return
+    if r.status_code == 200:
+        j = list(
+            map(
+                lambda x: {
+                    "uid": x["billableUnitUser"]["billableUnit"]["uid"],
+                    "displayName": x["billableUnitUser"]["billableUnit"]["displayName"],
+                },
+                r.json(),
+            )
+        )
+        print(json.dumps(j))
+    else:
+        print(f"Got status code: {r.status_code}")
+        print(r.text)
+        sys.exit(1)

{remotivelabs_cli-0.0.26 → remotivelabs_cli-0.0.27}/cli/cloud/projects.py

@@ -25,8 +25,8 @@ def list_projects(organisation: str = typer.Option(..., help="Organisation ID",
 
 @app.command(name="create")
 def create_project(
+    project_uid: str = typer.Argument(help="Project UID"),
     organisation: str = typer.Option(..., help="Organisation ID", envvar="REMOTIVE_CLOUD_ORGANISATION"),
-    project_uid: str = typer.Option(..., help="Project UID"),
     project_display_name: str = typer.Option(default="", help="Project display name"),
 ) -> None:
     create_project_req = {
@@ -39,5 +39,5 @@ def create_project(
 
 
 @app.command(name="delete")
-def delete(project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")) -> None:
+def delete(project: str = typer.Argument(help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")) -> None:
     Rest.handle_delete(url=f"/api/project/{project}")

{remotivelabs_cli-0.0.26 → remotivelabs_cli-0.0.27}/cli/cloud/recordings.py

@@ -309,23 +309,35 @@ def upload(  # noqa: C901
         err_console.print(f":boom: [bold red]Got status code[/bold red]: {upload_response.status_code} {upload_response.text}")
 
 
+# TODO - Change to use Path for directory  # pylint: disable=W0511
 @app.command()
 def upload_broker_configuration(  # noqa: C901
-    directory: str = typer.Argument(..., help="Configuration directory"),
+    directory: Path = typer.Argument(
+        ...,
+        exists=True,
+        file_okay=False,
+        dir_okay=True,
+        writable=False,
+        readable=True,
+        resolve_path=True,
+        help="Directory to upload",
+    ),
     recording_session: str = typer.Option(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
     overwrite: bool = typer.Option(False, help="Overwrite existing configuration if it exists"),
 ) -> None:
+    """
+    Uploads a broker configuration directory
+    """
     # pylint: disable=R0914,R0915
+
     # Must end with /
-    if not directory.endswith("/"):
-        directory = f"{directory}/"
 
     #
     # List files in specified directory. Look for interfaces.json and use that directory where this is located
     # as configuration home directory
     #
-    files = list(filter(lambda item: "interfaces.json" in item, glob.iglob(directory + "**/**", recursive=True)))
+    files = list(filter(lambda item: "interfaces.json" in item, glob.iglob(str(directory) + "/**/**", recursive=True)))
     if len(files) == 0:
         sys.stderr.write("No interfaces.json found in directory, this file is required")
         raise typer.Exit(1)
@@ -362,7 +374,7 @@ def upload_broker_configuration(  # noqa: C901
     file_infos = list(
         map(
             lambda item: {"local_path": item, "remote_path": f"/{broker_config_dir_name}{item.rsplit(broker_config_dir_name, 1)[-1]}"},
-            glob.iglob(directory + "**/*.*", recursive=True),
+            glob.iglob(str(directory) + "/**/*.*", recursive=True),
         )
     )
 
@@ -406,7 +418,7 @@ def upload_broker_configuration(  # noqa: C901
 
 
 @app.command(help="Downloads the specified broker configuration directory as zip file")
-def download_configuration(
+def download_broker_configuration(
     broker_config_name: str = typer.Argument(..., help="Broker config name"),
     recording_session: str = typer.Option(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
@@ -425,7 +437,7 @@ def download_configuration(
 
 
 @app.command(help="Delete the specified broker configuration")
-def delete_configuration(
+def delete_broker_configuration(
     broker_config_name: str = typer.Argument(..., help="Broker config name"),
     recording_session: str = typer.Option(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
@@ -436,11 +448,11 @@ def delete_configuration(
 @app.command(help="Copy recording to another project")
 def copy(
     recording_session: str = typer.Argument(..., help="Recording session id"),
-    project: str = typer.Option(..., help="Source project", envvar="REMOTIVE_CLOUD_PROJECT"),
-    destination_project: str = typer.Option(..., help="Destination project"),
+    from_project: str = typer.Option(..., help="Source project"),
+    to_project: str = typer.Option(..., help="Destination project"),
 ) -> None:
     Rest.handle_post(
-        url=f"/api/project/{project}/files/recording/{recording_session}/copy", body=json.dumps({"projectUid": destination_project})
+        url=f"/api/project/{from_project}/files/recording/{recording_session}/copy", body=json.dumps({"projectUid": to_project})
     )
 
 

{remotivelabs_cli-0.0.26 → remotivelabs_cli-0.0.27}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "remotivelabs-cli"
-version = "0.0.26"
+version = "0.0.27"
 description = "CLI for operating RemotiveCloud and RemotiveBroker"
 authors = ["Johan Rask <johan.rask@remotivelabs.com>"]
 readme = "README.md"