remotivelabs-cli 0.0.24__py3-none-any.whl → 0.0.26__py3-none-any.whl

cli/broker/record.py

@@ -9,7 +9,7 @@ from cli.errors import ErrorPrinter
 
 from .lib.broker import Broker
 
-app = typer.Typer(help=help)
+app = typer.Typer(help=help)  # type: ignore
 
 
 @app.command()
@@ -18,7 +18,7 @@ def start(
     namespace: List[str] = typer.Option(..., help="Namespace to record"),
     url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
     api_key: str = typer.Option("offline", help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
-):
+) -> None:
     try:
         broker = Broker(url, api_key)
         broker.record_multiple(namespace, filename)
@@ -32,7 +32,7 @@ def stop(
     namespace: List[str] = typer.Option(..., help="Namespace to record"),
     url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
     api_key: str = typer.Option("offline", help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
-):
+) -> None:
     try:
         broker = Broker(url, api_key)
         broker.stop_multiple(namespace, filename)

cli/broker/scripting.py

@@ -16,7 +16,7 @@ app = typer.Typer(
 )
 
 
-def write(signal_name, script):
+def write(signal_name: str, script: str) -> None:
     path = f"{signal_name}.lua"
     f = open(path, "w")
     f.write(script)
@@ -29,7 +29,7 @@ def new_script(
     input_signal: List[str] = typer.Option(..., help="Required input signal names"),
     output_signal: str = typer.Option(..., help="Name of output signal"),
     save: bool = typer.Option(False, help="Save file to disk - Default stored as __output_signal__.lua"),
-):
+) -> None:
     def to_subscribable_signal(sig: str) -> tuple[str, str]:
         arr = sig.split(":")
         if len(arr) != 2:
@@ -39,7 +39,7 @@ def new_script(
 
     signals_to_subscribe_to = list(map(to_subscribable_signal, input_signal))
 
-    def to_local_signal(sig_name: tuple[str, str]):
+    def to_local_signal(sig_name: tuple[str, str]) -> str:
         t = Template(
             """
     {
@@ -51,7 +51,7 @@ def new_script(
 
     local_signals = ",".join(list(map(to_local_signal, signals_to_subscribe_to)))
 
-    def to_subscribe_pattern(sig_name: tuple[str, str]):
+    def to_subscribe_pattern(sig_name: tuple[str, str]) -> str:
         t = Template(
             """
     if (signals["$sig_name"] ~= nil) then

cli/broker/signals.py

@@ -5,10 +5,10 @@ import numbers
 import os
 import signal as os_signal
 from pathlib import Path
-from typing import List, TypedDict
+from typing import Any, Dict, Iterable, List, TypedDict
 
 import grpc
-import plotext as plt
+import plotext as plt  # type: ignore
 import typer
 from rich import print as rich_rprint
 
@@ -16,7 +16,7 @@ from cli.errors import ErrorPrinter
 
 from .lib.broker import Broker, SubscribableSignal
 
-app = typer.Typer(help=help)
+app = typer.Typer(help=help)  # type: ignore
 
 
 # signal_values:list = list()
@@ -24,17 +24,17 @@ app = typer.Typer(help=help)
 
 class Signals(TypedDict):
     name: str
-    signals: List
+    signals: List[Any]
 
 
-signal_values = {}
+signal_values: Dict[Any, Any] = {}
 
 
 @app.command(help="List signals names on broker")
 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:
     try:
         broker = Broker(url, api_key)
         # print("Listing available signals")
@@ -73,7 +73,7 @@ def subscribe(  # noqa: C901
     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:
     """
     Subscribe to a selection of signals
 
@@ -100,10 +100,10 @@ def subscribe(  # noqa: C901
 
     plt.title("Signals")
 
-    def exit_on_ctrlc(sig, frame):
+    def exit_on_ctrlc(sig: Any, frame: Any) -> None:
         os._exit(0)
 
-    def on_frame_plot(x):
+    def on_frame_plot(x: Iterable[Any]) -> None:
         global signal_values
 
         plt.clt()  # to clear the terminal
@@ -144,7 +144,7 @@ def subscribe(  # noqa: C901
         plt.sleep(0.001)  # to add
         plt.show()
 
-    def on_frame_print(x):
+    def on_frame_print(x: Iterable[Any]) -> None:
         rich_rprint(json.dumps(list(x)))
 
     os_signal.signal(os_signal.SIGINT, exit_on_ctrlc)
@@ -181,7 +181,7 @@ def subscribe(  # noqa: C901
 def namespaces(
     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:
     try:
         broker = Broker(url, api_key)
         namespaces_json = broker.list_namespaces()

cli/cloud/__init__.py

@@ -1 +0,0 @@
-

cli/cloud/auth.py

@@ -4,29 +4,33 @@ import webbrowser
 from http.server import BaseHTTPRequestHandler, HTTPServer
 from pathlib import Path
 from threading import Thread
+from typing import Any
 
 import typer
+from typing_extensions import override
 
 from cli import settings
 
 from . import auth_tokens
-from . import rest_helper as rest
+from .rest_helper import RestHelper as Rest
 
-apa = settings.config_dir_name
+APA = settings.CONFIG_DIR_NAME
 
-help = """
+HELP = """
 Manage how you authenticate with our cloud platform
 """
 
-app = typer.Typer(help=help)
+httpd: HTTPServer
+
+app = typer.Typer(help=HELP)
 
 app.add_typer(auth_tokens.app, name="tokens", help="Manage users personal access tokens")
-config_dir_name = settings.config_dir_name  # str(Path.home()) + "/.config/.remotive/"
-token_file_name = settings.token_file_name  # str(Path.home()) + "/.config/.remotive/cloud.secret.token"
+CONFIG_DIR_NAME = settings.CONFIG_DIR_NAME  # str(Path.home()) + "/.config/.remotive/"
+TOKEN_FILE_NAME = settings.TOKEN_FILE_NAME  # str(Path.home()) + "/.config/.remotive/cloud.secret.token"
 
 
 class S(BaseHTTPRequestHandler):
-    def _set_response(self):
+    def _set_response(self) -> None:
         self.send_response(200)
         # self.send_response(301)
         # self.send_header('Location', 'https://cloud.remotivelabs.com')
@@ -34,10 +38,13 @@ class S(BaseHTTPRequestHandler):
         self.send_header("Content-type", "text/html")
         self.end_headers()
 
-    def log_message(self, format, *args):
+    def log_message(self, format: Any, *args: Any) -> None:  # pylint: disable=W0622
         return
 
-    def do_GET(self):  # noqa
+    # Please do not change this into lowercase!
+    @override
+    # type: ignore
+    def do_GET(self):  # pylint: disable=invalid-name,
         self._set_response()
         self.wfile.write("Successfully setup CLI, return to your terminal to continue".encode("utf-8"))
         path = self.path
@@ -47,15 +54,15 @@ class S(BaseHTTPRequestHandler):
         killerthread = Thread(target=httpd.shutdown)
         killerthread.start()
 
-        if not os.path.exists(config_dir_name):
-            os.makedirs(config_dir_name)
+        if not os.path.exists(CONFIG_DIR_NAME):
+            os.makedirs(CONFIG_DIR_NAME)
         write_token(path[1:])
         print("Successfully logged on, you are ready to go with cli")
 
 
-def start_local_webserver(server_class=HTTPServer, handler_class=S, port=0):
+def start_local_webserver(server_class: type = HTTPServer, handler_class: type = S, port: int = 0) -> None:
     server_address = ("", port)
-    global httpd
+    global httpd  # pylint: disable=W0603
     httpd = server_class(server_address, handler_class)
 
 
@@ -65,7 +72,7 @@ def start_local_webserver(server_class=HTTPServer, handler_class=S, port=0):
 
 
 @app.command(name="login")
-def login():
+def login() -> None:
     """
     Login to the cli using browser
 
@@ -73,20 +80,21 @@ def login():
     be the same as activating a personal access key or service-account access key.
     """
     start_local_webserver()
-    webbrowser.open(f"{rest.base_url}/login?redirectUrl=http://localhost:{httpd.server_address[1]}", new=1, autoraise=True)
+    webbrowser.open(f"{Rest.get_base_url()}/login?redirectUrl=http://localhost:{httpd.server_address[1]}", new=1, autoraise=True)
+
     httpd.serve_forever()
 
 
 @app.command()
-def whoami():
+def whoami() -> None:
     """
     Validates authentication and fetches your user information
     """
-    rest.handle_get("/api/whoami")
+    Rest.handle_get("/api/whoami")
 
 
 @app.command()
-def print_access_token():
+def print_access_token() -> None:
     """
     Print current active access token
     """
@@ -94,36 +102,33 @@ def print_access_token():
 
 
 @app.command(help="Clear access token")
-def logout():
-    os.remove(settings.token_file_name)
+def logout() -> None:
+    os.remove(settings.TOKEN_FILE_NAME)
     print("Access token removed")
 
 
-def read_token():
+def read_token() -> str:
     # f = open(token_file_name, "r")
     # token = f.read()
     # f.close()
     return settings.read_token()
 
 
-def read_file_with_path(file):
-    f = open(file, "r")
-    token = f.read()
-    f.close()
-    return token
+def read_file_with_path(file: str) -> str:
+    with open(file, "r", encoding="utf8") as f:
+        token = f.read()
+        return token
 
 
-def read_file(file):
-    f = open(str(Path.home()) + f"/.config/.remotive/{file}", "r")
-    token = f.read()
-    f.close()
-    return token
+def read_file(file: str) -> str:
+    with open(str(Path.home()) + f"/.config/.remotive/{file}", "r", encoding="utf8") as f:
+        token = f.read()
+        return token
 
 
-def write_token(token):
-    f = open(token_file_name, "w")
-    f.write(token)
-    f.close()
+def write_token(token: str) -> None:
+    with open(TOKEN_FILE_NAME, "w", encoding="utf8") as f:
+        f.write(token)
 
 
 # Key stuff

cli/cloud/auth_tokens.py

@@ -5,18 +5,21 @@ from pathlib import Path
 
 import typer
 
-from . import rest_helper as rest
+from .rest_helper import RestHelper as Rest
 
 app = typer.Typer()
 
-token_file_name = str(Path.home()) + "/.config/.remotive/cloud.secret.token"
-config_dir_name = str(Path.home()) + "/.config/.remotive/"
+TOKEN_FILE_NAME = str(Path.home()) + "/.config/.remotive/cloud.secret.token"
+CONFIG_DIR_NAME = str(Path.home()) + "/.config/.remotive/"
 
 
 @app.command(name="create", help="Create and download a new personal access token")
-def get_personal_access_token(activate: bool = typer.Option(False, help="Activate the token for use after download")):
-    rest.ensure_auth_token()
-    response = rest.handle_post(url="/api/me/keys", return_response=True)
+def get_personal_access_token(activate: bool = typer.Option(False, help="Activate the token for use after download")) -> None:  # pylint: disable=W0621
+    Rest.ensure_auth_token()
+    response = Rest.handle_post(url="/api/me/keys", return_response=True)
+
+    if response is None:
+        return
 
     if response.status_code == 200:
         name = response.json()["name"]
@@ -34,19 +37,19 @@ def get_personal_access_token(activate: bool = typer.Option(False, help="Activat
 
 
 @app.command(name="list", help="List personal access tokens")
-def list_personal_access_tokens():
-    rest.ensure_auth_token()
-    rest.handle_get("/api/me/keys")
+def list_personal_access_tokens() -> None:
+    Rest.ensure_auth_token()
+    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")):
-    rest.ensure_auth_token()
-    rest.handle_delete(f"/api/me/keys/{name}", success_msg="Successfully revoked")
+def revoke(name: str = typer.Option(..., help="Name of the access token to revoke")) -> None:
+    Rest.ensure_auth_token()
+    Rest.handle_delete(f"/api/me/keys/{name}")
 
 
 @app.command()
-def describe(file: str = typer.Option(..., help="File name")):
+def describe(file: str = typer.Option(..., help="File name")) -> None:
     """
     Show contents of specified access token file
     """
@@ -54,7 +57,7 @@ def describe(file: str = typer.Option(..., help="File name")):
 
 
 @app.command()
-def activate(file: str = typer.Argument(..., help="File name")):
+def activate(file: str = typer.Argument(..., help="File name")) -> None:
     """
     Activate a access token file to be used for authentication.
 
@@ -66,7 +69,7 @@ def activate(file: str = typer.Argument(..., help="File name")):
     do_activate(file)
 
 
-def do_activate(file: str):
+def do_activate(file: str) -> None:
     # Best effort to read file
     if os.path.exists(file):
         token_file = json.loads(read_file_with_path(file))
@@ -79,38 +82,38 @@ def do_activate(file: str):
 
 
 @app.command(name="list-files")
-def list_files():
+def list_files() -> None:
     """
     List personal access token files in remotivelabs config directory
     """
-    personal_files = filter(lambda f: f.startswith("personal"), os.listdir(config_dir_name))
+    personal_files = filter(lambda f: f.startswith("personal"), os.listdir(CONFIG_DIR_NAME))
     for file in personal_files:
         print(file)
 
 
-def read_file(file):
-    f = open(str(Path.home()) + f"/.config/.remotive/{file}", "r")
-    token = f.read()
-    f.close()
-    return token
+def read_file(file: str) -> str:
+    with open(str(Path.home()) + f"/.config/.remotive/{file}", "r", encoding="utf8") as f:
+        token = f.read()
+        f.close()
+        return token
 
 
-def read_file_with_path(file):
-    f = open(file, "r")
-    token = f.read()
-    f.close()
-    return token
+def read_file_with_path(file: str) -> str:
+    with open(file, "r", encoding="utf8") as f:
+        token = f.read()
+        f.close()
+        return token
 
 
-def write_token(token):
-    f = open(token_file_name, "w")
-    f.write(token)
-    f.close()
+def write_token(token: str) -> None:
+    with open(TOKEN_FILE_NAME, "w", encoding="utf8") as f:
+        f.write(token)
+        f.close()
 
 
-def write_personal_token(file: str, token: str):
+def write_personal_token(file: str, token: str) -> str:
     path = str(Path.home()) + f"/.config/.remotive/{file}"
-    f = open(path, "w")
-    f.write(token)
-    f.close()
-    return path
+    with open(path, "w", encoding="utf8") as f:
+        f.write(token)
+        f.close()
+        return path

cli/cloud/brokers.py

@@ -1,49 +1,40 @@
+from __future__ import annotations
+
 import json
 import os
 import signal as os_signal
+from typing import Any, Union
 
+import requests
 import typer
 import websocket
-from rich.progress import Progress, SpinnerColumn, TextColumn
 
-from . import rest_helper as rest
+from .rest_helper import RestHelper as Rest
 
 app = typer.Typer()
 
 
 @app.command("list", help="Lists brokers in project")
-def list(project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")):
-    rest.handle_get(f"/api/project/{project}/brokers")
+def list(project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")) -> None:  # pylint: disable=W0622
+    Rest.handle_get(f"/api/project/{project}/brokers")
 
 
 @app.command("describe", help="Shows details about a specific broker")
-def describe(name: str, project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")):
-    rest.handle_get(f"/api/project/{project}/brokers/{name}")
+def describe(name: str, project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")) -> None:
+    Rest.handle_get(f"/api/project/{project}/brokers/{name}")
 
 
 @app.command("delete", help="Stops and deletes a broker from project")
-def stop(name: str, project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")):
-    with Progress(
-        SpinnerColumn(),
-        TextColumn("[progress.description]{task.description}"),
-        transient=True,
-    ) as progress:
-        progress.add_task(description=f"Deleting broker {name}...", total=None)
-        rest.handle_delete(f"/api/project/{project}/brokers/{name}")
+def stop(name: str, project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")) -> None:
+    Rest.handle_delete(f"/api/project/{project}/brokers/{name}")
 
 
 @app.command(help="Deletes your personal broker from project")
-def delete_personal(project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")):
-    with Progress(
-        SpinnerColumn(),
-        TextColumn("[progress.description]{task.description}"),
-        transient=True,
-    ) as progress:
-        progress.add_task(description="Deleting personal broker...", total=None)
-        rest.handle_delete(f"/api/project/{project}/brokers/personal")
+def delete_personal(project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")) -> None:
+    Rest.handle_delete(f"/api/project/{project}/brokers/personal")
 
 
-def do_start(name: str, project: str, api_key: str, tag: str, return_response: bool = False):
+def do_start(name: str, project: str, api_key: str, tag: str, return_response: bool = False) -> Union[requests.Response, None]:
     if tag == "":
         tag_to_use = None
     else:
@@ -53,7 +44,7 @@ def do_start(name: str, project: str, api_key: str, tag: str, return_response: b
         body = {"size": "S", "tag": tag_to_use}
     else:
         body = {"size": "S", "apiKey": api_key, "tag": tag_to_use}
-    return rest.handle_post(
+    return Rest.handle_post(
         f"/api/project/{project}/brokers/{name}",
         body=json.dumps(body),
         return_response=return_response,
@@ -68,7 +59,7 @@ def start(
     tag: str = typer.Option("", help="Optional specific tag/version"),
     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}"),
@@ -84,7 +75,7 @@ def logs(
     tail: bool = typer.Option(False, help="Tail the broker log"),
     history_minutes: str = typer.Option(10, help="History in minutes minutes to fetch"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
-):
+) -> None:
     """
     Exposes broker logs history or real-time tail of the broker.
 
@@ -92,30 +83,30 @@ def logs(
 
     """
 
-    def exit_on_ctrlc(sig, frame):
+    def exit_on_ctrlc(__sig: Any, __frame: Any) -> None:
         wsapp.close()
         os._exit(0)
 
     os_signal.signal(os_signal.SIGINT, exit_on_ctrlc)
 
-    def on_message(wsapp, message):
+    def on_message(__wsapp: Any, message: str) -> None:
         print(message)
 
-    def on_error(wsapp, err):
+    def on_error(wsapp: Any, err: str) -> None:  # pylint: disable=W0613
         print("EXAMPLE error encountered: ", err)
 
-    rest.ensure_auth_token()
+    Rest.ensure_auth_token()
     # This will work with both http -> ws and https -> wss
-    ws_url = rest.base_url.replace("http", "ws")
+    ws_url = Rest.get_base_url().replace("http", "ws")
 
     if tail:
         q = "?tail=yes"
-    elif history_minutes != 10:
+    elif history_minutes != "10":
         q = f"?history={history_minutes}"
     else:
         q = ""
 
     wsapp = websocket.WebSocketApp(
-        f"{ws_url}/api/project/{project}/brokers/{broker_name}/logs{q}", header=rest.headers, on_message=on_message, on_error=on_error
+        f"{ws_url}/api/project/{project}/brokers/{broker_name}/logs{q}", header=Rest.get_headers(), on_message=on_message, on_error=on_error
     )
     wsapp.run_forever()

cli/cloud/cloud_cli.py

@@ -2,8 +2,9 @@ import json
 
 import typer
 
-from . import auth, brokers, configs, projects, recordings, sample_recordings, service_accounts
-from . import rest_helper as rest
+from cli.cloud.rest_helper import RestHelper
+
+from . import auth, brokers, configs, filestorage, projects, recordings, sample_recordings, service_accounts
 
 app = typer.Typer()
 
@@ -11,14 +12,16 @@ app = typer.Typer()
 @app.command(help="List licenses for an organisation")
 def licenses(
     organisation: str = typer.Option(..., help="Organisation ID", envvar="REMOTIVE_CLOUD_ORGANISATION"),
-    filter: str = typer.Option("all", help="all, valid, expired"),
-):
-    rest.handle_get(f"/api/bu/{organisation}/licenses", {"filter": filter})
+    filter_option: str = typer.Option("all", help="all, valid, expired"),
+) -> None:
+    RestHelper.handle_get(f"/api/bu/{organisation}/licenses", {"filter": filter_option})
 
 
 @app.command(help="List your available organisations")
-def organisations():
-    r = rest.handle_get("/api/home", return_response=True)
+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))
@@ -32,6 +35,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(service_accounts.app, name="service-accounts", help="Manage project service account keys")
 app.add_typer(sample_recordings.app, name="samples", help="Manage sample recordings")