remotivelabs-cli 0.0.42__tar.gz → 0.1.0__tar.gz

{remotivelabs_cli-0.0.42 → remotivelabs_cli-0.1.0}/PKG-INFO

@@ -1,16 +1,18 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: remotivelabs-cli
-Version: 0.0.42
+Version: 0.1.0
 Summary: CLI for operating RemotiveCloud and RemotiveBroker
 Author: Johan Rask
 Author-email: johan.rask@remotivelabs.com
-Requires-Python: >=3.8,<4
+Requires-Python: >=3.9,<4
 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
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: click (<8.2.0)
+Requires-Dist: dacite (>=1.9.2,<2.0.0)
 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.1.0/cli/api/cloud/tokens.py

@@ -0,0 +1,62 @@
+import dataclasses
+from typing import Any
+
+import requests
+
+from cli.utils.rest_helper import RestHelper as Rest
+
+#
+# Attempt to start cloud-api.
+# Might be better to generate somehow instead.
+# Lets discuss further
+#
+
+
+@dataclasses.dataclass
+class EmptyResponse:
+    is_success: bool
+    status_code: int
+
+
+@dataclasses.dataclass
+class JsonResponse:
+    is_success: bool
+    status_code: int
+    __response: requests.Response
+
+    def json(self) -> Any:
+        return self.__response.json()
+
+    def text(self) -> str:
+        return self.__response.text
+
+
+def __delete_response_from_response(response: requests.Response) -> EmptyResponse:
+    if 200 > response.status_code > 299:
+        ok = False
+    else:
+        ok = True
+    return EmptyResponse(is_success=ok, status_code=response.status_code)
+
+
+def __json_response_from_response(response: requests.Response) -> JsonResponse:
+    if 200 > response.status_code > 299:
+        ok = False
+    else:
+        ok = True
+    return JsonResponse(is_success=ok, status_code=response.status_code, __response=response)
+
+
+def create() -> JsonResponse:
+    response = Rest.handle_post(url="/api/me/keys", return_response=True)
+    return __json_response_from_response(response)
+
+
+def revoke(name: str) -> EmptyResponse:
+    res_revoke = Rest.handle_patch(f"/api/me/keys/{name}/revoke", quiet=True, allow_status_codes=[404, 401])
+    return __delete_response_from_response(res_revoke)
+
+
+def delete(name: str) -> EmptyResponse:
+    res_delete = Rest.handle_delete(f"/api/me/keys/{name}", quiet=True, allow_status_codes=[404, 401])
+    return __delete_response_from_response(res_delete)

{remotivelabs_cli-0.0.42 → remotivelabs_cli-0.1.0}/cli/broker/brokers.py

@@ -26,7 +26,6 @@ def main(
     if url is not None:
         os.environ["REMOTIVE_BROKER_URL"] = url
     # Do other global stuff, handle other global options here
-    return
 
 
 @app.command(help="Discover brokers on this network")

{remotivelabs_cli-0.0.42 → remotivelabs_cli-0.1.0}/cli/broker/export.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
-import os
 import signal as os_signal
+import sys
 from typing import Any, List
 
 import grpc
@@ -57,7 +57,7 @@ def influxdb(
     def exit_on_ctrlc(_sig: Any, _frame: Any) -> None:
         if output is not None:
             f.close()
-        os._exit(0)
+        sys.exit(0)
 
     def per_frame_influx_line_protocol(x: Any) -> None:
         signals = list(x)
@@ -67,7 +67,7 @@ def influxdb(
         frame = signals[0]["name"].rsplit(".", 1)[0]
         # frame_name = signals[0]["name"].split(".")[1]
         namespace = signals[0]["namespace"]
-        signals_str = ",".join(list(map(lambda s: f'{sig}={s["value"]}', signals)))
+        signals_str = ",".join(list(map(lambda s: f"{sig}={s['value']}", signals)))
         influx_lp = f"{frame},namespace={namespace} {signals_str} {round(signals[0]['timestamp_us'] * 1000)}"
         if output is not None:
             f.write(f"{influx_lp}\n")
@@ -112,7 +112,7 @@ def influxdb(
             arr = sig.split(":")
             if len(arr) != 2:
                 ErrorPrinter.print_hint(f"--signal must have format namespace:signal ({sig})")
-                exit(1)
+                sys.exit(1)
 
             return SubscribableSignal(namespace=arr[0], name=arr[1])
 

{remotivelabs_cli-0.0.42 → remotivelabs_cli-0.1.0}/cli/broker/lib/broker.py

@@ -6,6 +6,7 @@ import os
 import posixpath
 import queue
 import signal as os_signal
+import sys
 import tempfile
 import time
 import zipfile
@@ -59,9 +60,7 @@ class Broker:
                 os.environ["ACCESS_TOKEN"] = "false"
                 self.intercept_channel = br.create_channel(url, None, None)
         else:
-            err_console.print(
-                "Option --api-key will is deprecated and will be removed. " "Use access access tokens by logging in with cli."
-            )
+            err_console.print("Option --api-key will is deprecated and will be removed. Use access access tokens by logging in with cli.")
             os.environ["ACCESS_TOKEN"] = "false"
             self.intercept_channel = br.create_channel(url, api_key, None)
 
@@ -303,11 +302,10 @@ class Broker:
 
             for r in response:
                 if r["data"]:
-                    print(f'Successfully received traffic on {r["namespace"]}')
+                    print(f"Successfully received traffic on {r['namespace']}")
                     keep_running = False
-                else:
-                    if not wait_for_traffic or (not keep_running and not keep_running_during_recording):
-                        print(f'Namespace {r["namespace"]} did not receive any traffic')
+                elif not wait_for_traffic or (not keep_running and not keep_running_during_recording):
+                    print(f"Namespace {r['namespace']} did not receive any traffic")
 
     def upload(self, file: str, dest: str) -> None:
         try:
@@ -456,10 +454,8 @@ class Broker:
             if ns not in existing_ns:
                 ns_not_matching.append(ns)
         if len(ns_not_matching) > 0:
-            ErrorPrinter.print_hint(
-                f"Namespace(s) {ns_not_matching} does not exist on broker. " f"Namespaces found on broker: {existing_ns}"
-            )
-            exit(1)
+            ErrorPrinter.print_hint(f"Namespace(s) {ns_not_matching} does not exist on broker. Namespaces found on broker: {existing_ns}")
+            sys.exit(1)
 
         available_signals = list(filter(verify_namespace, existing_signals))  # type: ignore
         signals_to_subscribe_to = list(filter(find_subscribed_signal, available_signals))  # type: ignore
@@ -468,8 +464,8 @@ class Broker:
         signals_subscribed_to_but_does_not_exist = set(subscribed_signals) - set(map(lambda s: s["signal"], signals_to_subscribe_to))
 
         if len(signals_subscribed_to_but_does_not_exist) > 0:
-            ErrorPrinter.print_hint(f"One or more signals you subscribed to does not exist " f"{signals_subscribed_to_but_does_not_exist}")
-            exit(1)
+            ErrorPrinter.print_hint(f"One or more signals you subscribed to does not exist {signals_subscribed_to_but_does_not_exist}")
+            sys.exit(1)
 
         return list(map(lambda s: SubscribableSignal(s["signal"], s["namespace"]), signals_to_subscribe_to))
 

{remotivelabs_cli-0.0.42 → remotivelabs_cli-0.1.0}/cli/broker/license_flows.py

@@ -11,7 +11,7 @@ from rich.console import Console
 from rich.progress import Progress, SpinnerColumn, TextColumn
 
 from cli.broker.lib.broker import Broker, LicenseInfo
-from cli.cloud.rest_helper import RestHelper as Rest
+from cli.utils.rest_helper import RestHelper as Rest
 
 console = Console(stderr=True)
 

{remotivelabs_cli-0.0.42 → remotivelabs_cli-0.1.0}/cli/broker/scripting.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import sys
 from string import Template
 from typing import List
 
@@ -35,7 +36,7 @@ def new_script(
         arr = sig.split(":")
         if len(arr) != 2:
             ErrorPrinter.print_hint(f"--input-signal must have format namespace:signal ({sig})")
-            exit(1)
+            sys.exit(1)
         return arr[0], arr[1]
 
     signals_to_subscribe_to = list(map(to_subscribable_signal, input_signal))

{remotivelabs_cli-0.0.42 → remotivelabs_cli-0.1.0}/cli/broker/signals.py

@@ -4,6 +4,7 @@ import json
 import numbers
 import os
 import signal as os_signal
+import sys
 from datetime import datetime
 from pathlib import Path
 from typing import Any, Dict, Iterable, List, TypedDict, Union
@@ -60,11 +61,11 @@ def read_scripted_code_file(file_path: Path) -> bytes:
             return file.read()
     except FileNotFoundError:
         print("File not found. Please check your file path.")
-        exit(1)
+        sys.exit(1)
 
 
 @app.command()
-def subscribe(  # noqa: C901
+def subscribe(  # noqa: C901, PLR0913, PLR0915
     url: str = typer.Option(DEFAULT_GRPC_URL, 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"),
     signal: List[str] = typer.Option([], help="Signal names to subscribe to, mandatory when not using script"),
@@ -79,7 +80,7 @@ def subscribe(  # noqa: C901
         help="Supply a path to Lua script that to use for signal transformation",
     ),
     on_change_only: bool = typer.Option(default=False, help="Only get signal if value is changed"),
-    x_plot: bool = typer.Option(default=False, help="Experimental: Plot the signal in terminal. Note graphs are not " "aligned by time"),
+    x_plot: bool = typer.Option(default=False, help="Experimental: Plot the signal in terminal. Note graphs are not aligned by time"),
     x_plot_size: int = typer.Option(default=100, help="Experimental: how many points show for each plot"),
     # samples: int = typer.Option(default=0, he)
 ) -> None:
@@ -100,12 +101,12 @@ def subscribe(  # noqa: C901
     if script is None:
         if len(signal) == 0:
             ErrorPrinter.print_generic_error("You must use --signal or use --script when subscribing")
-            exit(1)
+            sys.exit(1)
 
     if script is not None:
         if len(signal) > 0:
             ErrorPrinter.print_generic_error("You must must not specify --signal when using --script")
-            exit(1)
+            sys.exit(1)
 
     plt.title("Signals")
 
@@ -113,8 +114,6 @@ def subscribe(  # noqa: C901
         os._exit(0)
 
     def on_frame_plot(x: Iterable[Any]) -> None:
-        global signal_values
-
         plt.clt()  # to clear the terminal
         plt.cld()  # to clear the data only
         frames = list(x)
@@ -146,9 +145,9 @@ def subscribe(  # noqa: C901
                 signal_values[f"ts_{name}"] = signal_values[f"ts_{name}"][len(signal_values[f"ts_{name}"]) - x_plot_size :]
 
         cnt = 1
-        for key in signal_values:
+        for key, value in signal_values.items():
             if not key.startswith("ts_"):
-                plt.subplot(cnt, 1).plot(signal_values[f"ts_{key}"], signal_values[key], label=key, color=cnt)
+                plt.subplot(cnt, 1).plot(signal_values[f"ts_{key}"], value, label=key, color=cnt)
                 cnt = cnt + 1
         plt.sleep(0.001)  # to add
         plt.show()
@@ -174,7 +173,7 @@ def subscribe(  # noqa: C901
                 arr = sig.split(":")
                 if len(arr) != 2:
                     ErrorPrinter.print_hint(f"--signal must have format namespace:signal ({sig})")
-                    exit(1)
+                    sys.exit(1)
                 return SubscribableSignal(namespace=arr[0], name=arr[1])
 
             signals_to_subscribe_to = list(map(to_subscribable_signal, signal))

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

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+import sys
+
+import typer
+
+from cli.cloud.auth.login import login as do_login
+from cli.errors import ErrorPrinter
+from cli.settings import TokenNotFoundError, settings
+from cli.typer import typer_utils
+from cli.utils.rest_helper import RestHelper as Rest
+
+from .. import auth_tokens
+
+HELP = """
+Manage how you authenticate with our cloud platform
+"""
+app = typer_utils.create_typer(help=HELP)
+# app.add_typer(auth_tokens.app, name="credentials", help="Manage account credentials")
+
+
+@app.command(name="login")
+def login(browser: bool = typer.Option(default=True, help="Does not automatically open browser, instead shows a link")) -> None:
+    """
+    Login to the cli using browser
+
+    If not able to open a browser it will show fallback to headless login and show a link that
+    users can copy into any browser when this is unsupported where running the cli - such as in docker,
+    virtual machine or ssh sessions.
+
+    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(headless=not browser)
+
+
+@app.command()
+def whoami() -> None:
+    """
+    Validates authentication and fetches your account information
+    """
+    try:
+        Rest.handle_get("/api/whoami")
+    except TokenNotFoundError as e:
+        ErrorPrinter.print_hint(str(e))
+        sys.exit(1)
+
+
+@app.command()
+def print_access_token(
+    account: str = typer.Option(None, help="Email of the account you want to print access token for, defaults to active"),
+) -> None:
+    """
+    Print current active access token or the token for the specified account
+    """
+    if account is None:
+        try:
+            print(settings.get_active_token())
+        except TokenNotFoundError:
+            ErrorPrinter.print_generic_error("You have no active account", exit_code=1)
+    else:
+        config = settings.get_cli_config()
+        if account in config.accounts:
+            token_name = config.accounts[account].credentials_name
+            try:
+                print(settings.get_token_file(token_name).token)
+            except TokenNotFoundError:
+                ErrorPrinter.print_generic_error(f"Token file for {account} could not be found", exit_code=1)
+        else:
+            ErrorPrinter.print_generic_error(f"No account for {account} was found", exit_code=1)
+
+
+def print_access_token_file() -> None:
+    """
+    Print current active token and its metadata
+    """
+    try:
+        print(settings.get_active_token_file())
+    except TokenNotFoundError as e:
+        ErrorPrinter.print_hint(str(e))
+        sys.exit(1)
+
+
+# @app.command(help="Clears active credentials")
+def logout() -> None:
+    settings.clear_active_token()
+    print("Access token removed")
+
+
+app.command("activate")(auth_tokens.select_personal_token)
+app.command("list")(auth_tokens.list_pats_files)