remotivelabs-cli 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

cli/broker/signals.py

@@ -12,10 +12,9 @@ from typing import Any, Dict, Iterable, List, TypedDict, Union
 import grpc
 import plotext as plt  # type: ignore
 import typer
-from rich import print as rich_rprint
 
-from cli.errors import ErrorPrinter
 from cli.typer import typer_utils
+from cli.utils.console import print_generic_error, print_generic_message, print_grpc_error, print_hint
 
 from .lib.broker import Broker, SubscribableSignal
 
@@ -23,8 +22,6 @@ app = typer_utils.create_typer(help=help)
 
 DEFAULT_GRPC_URL = "http://localhost:50051"
 
-# signal_values:list = list()
-
 
 class Signals(TypedDict):
     name: str
@@ -49,18 +46,18 @@ def list_signals(
     try:
         broker = Broker(url, api_key)
         available_signals = broker.list_signal_names(prefix=name_starts_with, suffix=name_ends_with)
-        print(json.dumps(available_signals))
+        print_generic_message(json.dumps(available_signals))
     except grpc.RpcError as rpc_error:
-        ErrorPrinter.print_grpc_error(rpc_error)
+        print_grpc_error(rpc_error)
 
 
 def read_scripted_code_file(file_path: Path) -> bytes:
     try:
-        print(file_path)
+        print_generic_message(str(file_path))
         with open(file_path, "rb") as file:
             return file.read()
     except FileNotFoundError:
-        print("File not found. Please check your file path.")
+        print_generic_error("File not found. Please check your file path.")
         sys.exit(1)
 
 
@@ -100,12 +97,12 @@ def subscribe(  # noqa: C901, PLR0913, PLR0915
 
     if script is None:
         if len(signal) == 0:
-            ErrorPrinter.print_generic_error("You must use --signal or use --script when subscribing")
+            print_generic_error("You must use --signal or use --script when subscribing")
             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")
+            print_generic_error("You must must not specify --signal when using --script")
             sys.exit(1)
 
     plt.title("Signals")
@@ -153,7 +150,8 @@ def subscribe(  # noqa: C901, PLR0913, PLR0915
         plt.show()
 
     def on_frame_print(x: Iterable[Any]) -> None:
-        rich_rprint(json.dumps(list(x)))
+        # TODO: use log instead of print for debug information?
+        print_generic_message(json.dumps(list(x)))
 
     os_signal.signal(os_signal.SIGINT, exit_on_ctrlc)
 
@@ -172,7 +170,7 @@ def subscribe(  # noqa: C901, PLR0913, PLR0915
             def to_subscribable_signal(sig: str):
                 arr = sig.split(":")
                 if len(arr) != 2:
-                    ErrorPrinter.print_hint(f"--signal must have format namespace:signal ({sig})")
+                    print_hint(f"--signal must have format namespace:signal ({sig})")
                     sys.exit(1)
                 return SubscribableSignal(namespace=arr[0], name=arr[1])
 
@@ -180,9 +178,9 @@ def subscribe(  # noqa: C901, PLR0913, PLR0915
 
             broker = Broker(url, api_key)
             broker.long_name_subscribe(signals_to_subscribe_to, on_frame_func, on_change_only)
-        print("Subscribing to signals, press Ctrl+C to exit")
+        print_generic_message("Subscribing to signals, press Ctrl+C to exit")
     except grpc.RpcError as rpc_error:
-        ErrorPrinter.print_grpc_error(rpc_error)
+        print_grpc_error(rpc_error)
 
 
 @app.command(help="List namespaces on broker")
@@ -193,9 +191,9 @@ def namespaces(
     try:
         broker = Broker(url, api_key)
         namespaces_json = broker.list_namespaces()
-        print(json.dumps(namespaces_json))
+        print_generic_message(json.dumps(namespaces_json))
     except grpc.RpcError as rpc_error:
-        ErrorPrinter.print_grpc_error(rpc_error)
+        print_grpc_error(rpc_error)
 
 
 @app.command()
@@ -214,11 +212,11 @@ def frame_distribution(
             timestamp: str = datetime.now().strftime("%H:%M:%S")
             distribution = data["countsByFrameId"]
             if len(distribution) == 0:
-                ErrorPrinter.print_hint(f"{timestamp} - No frames available")
+                print_hint(f"{timestamp} - No frames available")
             else:
                 for d in distribution:
-                    ErrorPrinter.print_generic_message(f"{timestamp}: {d}")
+                    print_generic_message(f"{timestamp}: {d}")
 
         broker.listen_on_frame_distribution(namespace, on_data)
     except grpc.RpcError as rpc_error:
-        ErrorPrinter.print_grpc_error(rpc_error)
+        print_grpc_error(rpc_error)

cli/cloud/auth/cmd.py

@@ -1,15 +1,16 @@
 from __future__ import annotations
 
 import os
+import sys
 
 import typer
 from rich.console import Console
 from rich.table import Table
 
 from cli.cloud.auth.login import login as do_login
-from cli.errors import ErrorPrinter
 from cli.settings import settings
 from cli.typer import typer_utils
+from cli.utils.console import print_generic_error, print_generic_message, print_success, print_unformatted
 from cli.utils.rest_helper import RestHelper as Rest
 
 from .. import auth_tokens
@@ -52,24 +53,24 @@ def print_access_token(
     if not account:
         active_token = settings.get_active_token() or os.getenv("REMOTIVE_CLOUD_ACCESS_TOKEN", None)
         if not active_token:
-            ErrorPrinter.print_generic_error("You have no active account", exit_code=1)
-            return
+            print_generic_error("You have no active account")
+            sys.exit(1)
 
-        print(active_token)
+        print_generic_message(active_token)
         return
 
     accounts = settings.list_accounts()
     if account not in accounts:
-        ErrorPrinter.print_generic_error(f"No account for {account} was found", exit_code=1)
-        return
+        print_generic_error(f"No account for {account} was found")
+        sys.exit(1)
 
     token_file_name = accounts[account].credentials_file
     token_file = settings.get_token_file(token_file_name)
     if not token_file:
-        ErrorPrinter.print_generic_error(f"Token file for {account} could not be found", exit_code=1)
-        return
+        print_generic_error(f"Token file for {account} could not be found")
+        sys.exit(1)
 
-    print(token_file.token)
+    print_generic_message(token_file.token)
 
 
 def print_access_token_file() -> None:
@@ -78,10 +79,10 @@ def print_access_token_file() -> None:
     """
     active_token_file = settings.get_active_token_file()
     if not active_token_file:
-        ErrorPrinter.print_generic_error("You have no active account", exit_code=1)
-        return
+        print_generic_error("You have no active account")
+        sys.exit(1)
 
-    print(active_token_file)
+    print_generic_message(str(active_token_file))
 
 
 @app.command(name="deactivate")
@@ -90,7 +91,7 @@ def deactivate() -> None:
     Clears active account
     """
     settings.clear_active_account()
-    print("Account no longer active")
+    print_success("Account no longer active")
 
 
 @app.command("activate")
@@ -105,6 +106,8 @@ def activate(token_name: str = typer.Argument(None, help="Name, filename or path
 def list() -> None:
     """
     Lists available credential files on filesystem
+
+    TODO: Support output format
     """
     accounts = settings.list_accounts()
 
@@ -123,4 +126,4 @@ def list() -> None:
             str(token_file.created) if token_file else "",
             str(token_file.expires) if token_file else "",
         )
-    console.print(table)
+    print_unformatted(table)

cli/cloud/auth/login.py

@@ -13,19 +13,16 @@ from typing import Any, Optional, Tuple
 from urllib.parse import parse_qs, urlparse
 
 import typer
-from rich.console import Console
 from typing_extensions import override
 
 from cli.cloud.auth_tokens import do_activate, prompt_to_set_org
-from cli.errors import ErrorPrinter
 from cli.settings import settings
 from cli.settings.token_file import TokenFile
+from cli.utils.console import print_generic_error, print_newline, print_success, print_unformatted, print_url
 from cli.utils.rest_helper import RestHelper as Rest
 
 httpd: HTTPServer
 
-console = Console()
-
 
 def generate_pkce_pair() -> Tuple[str, str]:
     """
@@ -79,8 +76,7 @@ class S(BaseHTTPRequestHandler):
                 allow_status_codes=[401, 400],
             )
             if res.status_code != 200:
-                print(res.text)
-                ErrorPrinter.print_generic_error(
+                print_generic_error(
                     "Failed to fetch token. Please try again, if the problem persists please reach out to support@remotivelabs.com"
                 )
                 self.wfile.write(
@@ -95,7 +91,6 @@ class S(BaseHTTPRequestHandler):
                 """Successfully setup CLI, you may close this window now. Return to your terminal to continue""".encode("utf-8")
             )
             access_token = res.json()["access_token"]
-
             global short_lived_token  # noqa: PLW0603
             short_lived_token = access_token
 
@@ -109,7 +104,7 @@ class S(BaseHTTPRequestHandler):
                 Run `remotive cloud auth login` to try again.
                 """.encode("utf-8")
                 )
-                ErrorPrinter.print_generic_error("You did not grant access to RemotiveCloud, login aborted")
+                print_generic_error("You did not grant access to RemotiveCloud, login aborted")
             elif error_value == "user_not_exists":
                 self.wfile.write(
                     """
@@ -120,22 +115,19 @@ class S(BaseHTTPRequestHandler):
                 Once you are signed up, Run `remotive cloud auth login` again.
                 """.encode("utf-8")
                 )
-                ErrorPrinter.print_generic_error(
+                print_generic_error(
                     "To use RemotiveCLI you must first sign up at https://cloud.remotivelabs.com and approve our agreements"
                 )
             else:
                 self.wfile.write(f"Unknown error {error_value}, please contact support@remotivelabs.com".encode("utf-8"))
-                ErrorPrinter.print_generic_error(f"Unexpected error {error_value}, please contact support@remotivelabs.com")
+                print_generic_error(f"Unexpected error {error_value}, please contact support@remotivelabs.com")
             sys.exit(1)
 
 
 def prepare_local_webserver(server_class: type = HTTPServer, handler_class: type = S, port: Optional[int] = None) -> None:
     if port is None:
         env_val = os.getenv("REMOTIVE_LOGIN_CALLBACK_PORT" or "")
-        if env_val and env_val.isdigit():
-            port = int(env_val)
-        else:
-            port = 0
+        port = int(env_val) if env_val and env_val.isdigit() else 0
 
     server_address = ("", port)
     global httpd  # noqa: PLW0603
@@ -153,7 +145,6 @@ def create_personal_token() -> None:
     email = token["account"]["email"]
     existing_file = settings.get_token_file_by_email(email=email)
     if existing_file is not None:
-        # ErrorPrinter.print_hint(f"Revoking and deleting existing credentials [remove_me]{existing_file.name}")
         res = Rest.handle_patch(
             f"/api/me/keys/{existing_file.name}/revoke",
             quiet=True,
@@ -170,7 +161,7 @@ def create_personal_token() -> None:
 
     settings.add_personal_token(response.text, activate=True)
 
-    print("Successfully logged on")
+    print_success("Logged in")
 
 
 def _do_prompt_to_use_existing_credentials() -> Optional[TokenFile]:
@@ -232,8 +223,8 @@ def login(headless: bool = False) -> bool:  # noqa: C901, PLR0915
         """
         This will print a url the will trigger a callback later so the webserver must be up and running.
         """
-        print("Copy the following link in a browser to login to cloud, and complete the sign-in prompts:")
-        print("")
+        print_unformatted("Copy the following link in a browser to login to cloud, and complete the sign-in prompts:")
+        print_newline()
 
         url = (
             f"{Rest.get_base_frontend_url()}/login"
@@ -243,15 +234,15 @@ def login(headless: bool = False) -> bool:  # noqa: C901, PLR0915
             f"&code_challenge={code_challenge}"
             f"&redirect_uri=http://localhost:{httpd.server_address[1]}"
         )
-        console.print(url, style="bold", soft_wrap=True)
+        print_url(url)
         httpd.serve_forever()
 
     def login_headless() -> None:
         """
         Full headless, opens a browser and expects a auth code to be entered and exchanged for the token
         """
-        print("Copy the following link in a browser to login to cloud, and complete the sign-in prompts:")
-        print("")
+        print_unformatted("Copy the following link in a browser to login to cloud, and complete the sign-in prompts:")
+        print_newline()
 
         url = (
             f"{Rest.get_base_frontend_url()}/login"
@@ -260,7 +251,7 @@ def login(headless: bool = False) -> bool:  # noqa: C901, PLR0915
             f"&response_type=code"
             f"&code_challenge={code_challenge}"
         )
-        console.print(url, style="bold", soft_wrap=True)
+        print_url(url)
 
         code = typer.prompt(
             "Once finished, enter the verification code provided in your browser",
@@ -273,12 +264,11 @@ def login(headless: bool = False) -> bool:  # noqa: C901, PLR0915
             allow_status_codes=[401],
         )
         if res.status_code == 401:
-            ErrorPrinter.print_generic_error(
+            print_generic_error(
                 "Failed to fetch token. Please try again, if the problem persists please reach out to support@remotivelabs.com"
             )
             sys.exit(1)
         access_token = res.json()["access_token"]
-        # res = Rest.handle_get("/api/whoami", return_response=True, access_token=access_token)
         global short_lived_token  # noqa: PLW0603
         short_lived_token = access_token
         create_personal_token()
@@ -299,10 +289,10 @@ def login(headless: bool = False) -> bool:  # noqa: C901, PLR0915
         )
 
         if not could_open:
-            print(
+            print_generic_error(
                 "Could not open a browser on this machine, this is likely because you are in an environment where no browser is available"
             )
-            print("")
+            print_newline()
             if force_use_webserver_callback():
                 login_with_callback_but_copy_url()
                 create_personal_token()

cli/cloud/auth_tokens.py

@@ -3,18 +3,14 @@ from __future__ import annotations
 from typing import List, Optional
 
 import typer
-from rich.console import Console
 from rich.table import Table
 
 from cli.cloud.organisations import do_select_default_org
-from cli.errors import ErrorPrinter
 from cli.settings import settings
 from cli.settings.token_file import TokenFile
+from cli.utils.console import print_generic_error, print_generic_message, print_hint, print_newline, print_success, print_unformatted
 from cli.utils.rest_helper import RestHelper as Rest
 
-console = Console(stderr=False)
-err_console = Console(stderr=True)
-
 
 def _prompt_choice(  # noqa: C901
     choices: List[TokenFile],
@@ -59,14 +55,14 @@ def _prompt_choice(  # noqa: C901
             str(choice.created),
             str(choice.expires),
         )
-    console.print(table)
+    print_unformatted(table)
 
     if skip_prompt:
         return None
 
-    typer.echo("")
-    if info_message is not None:
-        console.print(info_message)
+    print_newline()
+    if info_message:
+        print_generic_message(info_message)
 
     selection = typer.prompt(
         f"Enter the number(# 1-{len(included_tokens)}) of the account to select (q to quit)",
@@ -101,7 +97,7 @@ def do_activate(token_name: Optional[str]) -> Optional[TokenFile]:
     if token_name:
         token_file = settings.get_token_file(token_name)
         if not token_file:
-            err_console.print(f":boom: [bold red] Error: [/bold red] Token with filename or name {token_name} could not be found")
+            print_generic_error(f"Token with filename or name {token_name} could not be found")
             return None
         return settings.activate_token(token_file)
 
@@ -112,16 +108,16 @@ def do_activate(token_name: Optional[str]) -> Optional[TokenFile]:
         if token_selected is not None:
             is_logged_in = Rest.has_access("/api/whoami")
             if not is_logged_in:
-                ErrorPrinter.print_generic_error("Could not access RemotiveCloud with selected token")
+                print_generic_error("Could not access RemotiveCloud with selected token")
             else:
-                console.print("[green]Success![/green] Access to RemotiveCloud granted")
+                print_success("Access to RemotiveCloud granted")
                 # Only select default if activate was done with selection and successful
                 # and not SA since SA cannot list available organizations
                 if token_selected.type == "authorized_user":
                     prompt_to_set_org()
         return token_selected
 
-    ErrorPrinter.print_hint("No credentials available, login to activate credentials")
+    print_hint("No credentials available, login to activate credentials")
     return None
 
 

cli/cloud/brokers.py

@@ -10,6 +10,7 @@ import typer
 import websocket
 
 from cli.typer import typer_utils
+from cli.utils.console import print_generic_message
 from cli.utils.rest_helper import RestHelper as Rest
 
 app = typer_utils.create_typer()
@@ -61,12 +62,6 @@ def start(
     silent: bool = typer.Option(False, help="Optional specific tag/version"),
     api_key: str = typer.Option("", help="Start with your own api-key"),
 ) -> None:
-    # with Progress(
-    #        SpinnerColumn(),
-    #        TextColumn("[progress.description]{task.description}"),
-    #        transient=True,
-    # ) as progress:
-    #    progress.add_task(description=f"Starting broker {name}...", total=None)
     do_start(name, project, api_key, tag, return_response=silent)
 
 
@@ -81,7 +76,6 @@ def logs(
     Exposes broker logs history or real-time tail of the broker.
 
     When using --tail option, --history always skipped even if supplied
-
     """
 
     def exit_on_ctrlc(_sig: Any, _frame: Any) -> None:
@@ -91,10 +85,12 @@ def logs(
     os_signal.signal(os_signal.SIGINT, exit_on_ctrlc)
 
     def on_message(_wsapp: Any, message: str) -> None:
-        print(message)
+        # TODO: use log instead of print for debug information?
+        print_generic_message(message)
 
     def on_error(_wsapp: Any, err: str) -> None:
-        print("EXAMPLE error encountered: ", err)
+        # TODO: use log instead of print for debug information?
+        print_generic_message(f"Error encountered: {err}")
 
     Rest.ensure_auth_token()
     # This will work with both http -> ws and https -> wss

cli/cloud/configs.py

@@ -1,6 +1,5 @@
 import os.path
 import shutil
-import sys
 from pathlib import Path
 
 import requests
@@ -8,6 +7,7 @@ import typer
 from rich.progress import Progress, SpinnerColumn, TextColumn
 
 from cli.typer import typer_utils
+from cli.utils.console import print_generic_error, print_success
 from cli.utils.rest_helper import RestHelper as Rest
 
 app = typer_utils.create_typer()
@@ -102,21 +102,8 @@ def download(
             if download_resp.status_code == 200:
                 with open(signal_db_file, "wb") as out_file:
                     shutil.copyfileobj(download_resp.raw, out_file)
-                print(f"{signal_db_file} downloaded")
+                print_success(f"{signal_db_file} downloaded")
             else:
-                sys.stderr.write(f"Got unexpected status {download_resp.status_code}\n")
+                print_generic_error(f"Got unexpected status {download_resp.status_code}")
         else:
-            sys.stderr.write(f"Got unexpected status {get_signed_url_resp.status_code}\n")
-
-
-# @app.command()
-# def upload(file: str, project: str = typer.Option(..., help="Project ID", envvar='REMOTIVE_CLOUD_PROJECT')):
-# files = {'upload_file': open(file, 'rb')}
-# values = {'DB': 'photcat', 'OUT': 'csv', 'SHORT': 'short'}
-# rest.headers["content-type"] = "application/octet-stream"
-# r = requests.get(f"{rest.base_url}/api/project/{project}/files/recording/upload/{file}", headers=rest.headers)
-# print(r.status_code)
-# print(r.text)
-
-# pylint: disable=C0301
-# curl -X PUT -H 'Content-Type: application/octet-stream' --upload-file docker-compose.yml 'https://storage.googleapis.com/beamylabs-fileuploads-dev/projects/beamyhack/recording/myrecording?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=recordings-upload-account%40beamycloud-dev.iam.gserviceaccount.com%2F20220729%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20220729T134012Z&X-Goog-Expires=3000&X-Goog-SignedHeaders=content-type%3Bhost&X-Goog-Signature=d1fa7639349d6453aebfce8814d6e5685af03952d07aa4e3cb0d44dba7cf5e572f684c8120dba17cbc7ea6a0ef5450542a3c745c65e04272b34265d0ddcf1b67e6f2b5bfa446264a62d77bd7faabf45ad6bd2aec5225f57004b0a31cfe0480cba063a3807d86346b1da99ecbae3f3e6da8f44f06396dfc1fdc6f89e475abdf969142cef6f369f03aff41000c8abb28aa82185246746fd6c16b6b381baa2d586382a3d3067b6376ddba2b55b2b6f9d942913a1cbfbc61491ba6a615d7d5a0d9a476c357431143e9cea1411dfad9f01b1e1176dc8c056cbf08cccfd401a55d63c19d038f3ab42b712abc48d759047ac07862c4fae937c341e19b568bb60a4e4086'
+            print_generic_error(f"Got unexpected status {get_signed_url_resp.status_code}\n")

cli/cloud/organisations.py

@@ -5,15 +5,13 @@ from dataclasses import dataclass
 from typing import List, Optional
 
 import typer
-from rich.console import Console
 from rich.table import Table
 
-from cli.errors import ErrorPrinter
 from cli.settings import settings
 from cli.typer import typer_utils
+from cli.utils.console import print_generic_error, print_generic_message, print_hint, print_newline, print_unformatted_to_stderr
 from cli.utils.rest_helper import RestHelper
 
-console = Console(stderr=False)
 app = typer_utils.create_typer()
 
 
@@ -36,9 +34,9 @@ def _prompt_choice(choices: List[Organisation]) -> Optional[Organisation]:
             choice.uid,
             ":thumbsup:" if current_default_org is not None and current_default_org == choice.uid else "",
         )
-    console.print(table)
+    print_unformatted_to_stderr(table)
 
-    typer.echo("")
+    print_newline()
     selection = typer.prompt(f"Enter the number(# 1-{len(choices)}) of the organization to select (or q to quit)")
 
     if selection == "q":
@@ -49,7 +47,7 @@ def _prompt_choice(choices: List[Organisation]) -> Optional[Organisation]:
             return choices[index]
         raise ValueError
     except ValueError:
-        typer.echo("Invalid choice, please try again")
+        print_generic_error("Invalid choice, please try again")
         return _prompt_choice(choices)
 
 
@@ -75,16 +73,16 @@ def do_select_default_org(organisation_uid: Optional[str] = None, get: bool = Fa
     active_account = settings.get_active_account()
     if get:
         if active_account and active_account.default_organization:
-            console.print(active_account.default_organization)
+            print_unformatted_to_stderr(active_account.default_organization)
         else:
-            console.print("No default organization set")
+            print_unformatted_to_stderr("No default organization set")
     elif organisation_uid is not None:
         settings.set_default_organisation(organisation_uid)
     else:
         if active_account:
             token = settings.get_token_file(active_account.credentials_file)
             if token and token.type != "authorized_user":
-                ErrorPrinter.print_hint(
+                print_hint(
                     "You must supply the organization name as argument when using a service-account since the "
                     "service-account is not allowed to list"
                 )
@@ -105,4 +103,4 @@ def do_select_default_org(organisation_uid: Optional[str] = None, get: bool = Fa
 def list_orgs() -> None:
     r = RestHelper.handle_get("/api/bu", return_response=True)
     orgs = [{"uid": org["organisation"]["uid"], "displayName": org["organisation"]["displayName"]} for org in r.json()]
-    print(json.dumps(orgs))
+    print_generic_message(json.dumps(orgs))

cli/cloud/projects.py

@@ -3,6 +3,7 @@ import json
 import typer
 
 from cli.typer import typer_utils
+from cli.utils.console import print_generic_error, print_generic_message
 from cli.utils.rest_helper import RestHelper as Rest
 
 app = typer_utils.create_typer()
@@ -18,10 +19,9 @@ def list_projects(organization: str = typer.Option(..., help="Organization ID",
         # extract the project uid parts
         projects = r.json()["projects"]
         projects = map(lambda p: p["uid"], projects)
-        print(json.dumps(list(projects)))
+        print_generic_message(json.dumps(list(projects)))
     else:
-        print(r.status_code)
-        print(r.text)
+        print_generic_error(f"Got unexpected status {r.status_code}\n")
 
 
 @app.command(name="create")