remotivelabs-cli 0.0.1a35__tar.gz → 0.0.1a36__tar.gz

{remotivelabs_cli-0.0.1a35 → remotivelabs_cli-0.0.1a36}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: remotivelabs-cli
-Version: 0.0.1a35
+Version: 0.0.1a36
 Summary: 
 Author: Johan Rask
 Author-email: johan.rask@remotivelabs.com
@@ -28,6 +28,55 @@ Read more at https://docs.remotivelabs.com/docs/cloud-cli/Installation
 
 You can use our CLI against both cloud and broker.
 
+## Cloud
+
+Here summary of what you can do with the cli, for a complete list of cloud features
+visit https://docs.remotivelabs.com/docs/category/remotivecloud/
+
+The CLI does not currently support everything but we are working on having them in pair.
+
+* remotive cloud auth
+  * Login / Logout
+  * Manage personal and service account tokens
+
+* remotive cloud brokers
+  * Create broker
+  * Delete broker
+  * List brokers
+  * View broker logs
+
+* remotive cloud licenses 
+  * View physical broker licenses for your organisation
+
+* remotive cloud recordings
+  * Upload recording
+  * Play recording
+  * List recordings
+  * Download recordings
+  * Upload custom configuration (i.e signal transformation)
+  * Download custom configurations
+  * Delete recordings and configurations
+
+* remotive cloud signal-databases
+  * Upload
+  * Download
+  * Delete
+
+* remotive cloud projects
+  * Create
+  * Delete
+  * List
+
+* remotve cloud service-accounts
+  * Create
+  * Delete
+  * List
+
+
+### Broker
+
+    remotive cloud auth
+
 ## Subscribe to signals
 
 Output from running subscribe against our demo. You can visit https://demoo.remotivelabs.com

{remotivelabs_cli-0.0.1a35 → remotivelabs_cli-0.0.1a36}/README.md

@@ -8,6 +8,55 @@ Read more at https://docs.remotivelabs.com/docs/cloud-cli/Installation
 
 You can use our CLI against both cloud and broker.
 
+## Cloud
+
+Here summary of what you can do with the cli, for a complete list of cloud features
+visit https://docs.remotivelabs.com/docs/category/remotivecloud/
+
+The CLI does not currently support everything but we are working on having them in pair.
+
+* remotive cloud auth
+  * Login / Logout
+  * Manage personal and service account tokens
+
+* remotive cloud brokers
+  * Create broker
+  * Delete broker
+  * List brokers
+  * View broker logs
+
+* remotive cloud licenses 
+  * View physical broker licenses for your organisation
+
+* remotive cloud recordings
+  * Upload recording
+  * Play recording
+  * List recordings
+  * Download recordings
+  * Upload custom configuration (i.e signal transformation)
+  * Download custom configurations
+  * Delete recordings and configurations
+
+* remotive cloud signal-databases
+  * Upload
+  * Download
+  * Delete
+
+* remotive cloud projects
+  * Create
+  * Delete
+  * List
+
+* remotve cloud service-accounts
+  * Create
+  * Delete
+  * List
+
+
+### Broker
+
+    remotive cloud auth
+
 ## Subscribe to signals
 
 Output from running subscribe against our demo. You can visit https://demoo.remotivelabs.com

{remotivelabs_cli-0.0.1a35 → remotivelabs_cli-0.0.1a36}/cli/cloud/brokers.py

@@ -22,14 +22,14 @@ def describe(name: str, project: str = typer.Option(..., help="Project ID", envv
     rest.handle_get(f"/api/project/{project}/brokers/{name}")
 
 
-@app.command("remove", help="Stops and removes a broker from project")
+@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"Stopping broker {name}...", total=None)
+        progress.add_task(description=f"Deleting broker {name}...", total=None)
         rest.handle_delete(f"/api/project/{project}/brokers/{name}")
 
 

{remotivelabs_cli-0.0.1a35 → remotivelabs_cli-0.0.1a36}/cli/cloud/recordings.py

@@ -18,8 +18,9 @@ def uid(p):
     print(p)
     return p['uid']
 
+
 # to be used in options
-#autocompletion=project_names)
+# autocompletion=project_names)
 def project_names():
     r = requests.get(f'{rest.base_url}/api/bu/{rest.org}/project', headers=rest.headers)
     # sys.stderr.write(r.text)
@@ -40,7 +41,8 @@ def project_names():
 
 
 @app.command("list")
-def listRecordings(is_processing: bool = typer.Option(default=False, help="Use this option to see only those that are beeing processed or are invalid"),
+def listRecordings(is_processing: bool = typer.Option(default=False,
+                                                      help="Use this option to see only those that are beeing processed or are invalid"),
                    project: str = typer.Option(..., help="Project ID", envvar='REMOTIVE_CLOUD_PROJECT')):
     """
     List all recording sessions in a project. You can choose to see all valid recordings (default) or use
@@ -54,7 +56,6 @@ def listRecordings(is_processing: bool = typer.Option(default=False, help="Use t
         rest.handle_get(f"/api/project/{project}/files/recording")
 
 
-
 @app.command(help="Shows details about a specific recording in project")
 def describe(recording_session: str = typer.Argument(..., help="Recording session id"),
 
@@ -72,10 +73,11 @@ def doStart(name: str, project: str, api_key: str, return_response: bool = False
 
 
 @app.command(help="Plays all recording files or a single recording")
-def play(recording_session: str = typer.Argument(..., help="Recording session id", envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
+def play(recording_session: str = typer.Argument(..., help="Recording session id",
+                                                 envvar="REMOTIVE_CLOUD_RECORDING_SESSION"),
          broker: str = typer.Option(..., help="Broker name to play on"),
          ensure_broker_started: bool = typer.Option(default=False, help="Ensure broker exists, start otherwise"),
-         broker_config_name: str = typer.Option("default", help="Specify a custom broker configuration to use" ),
+         broker_config_name: str = typer.Option("default", help="Specify a custom broker configuration to use"),
          project: str = typer.Option(..., help="Project ID", envvar='REMOTIVE_CLOUD_PROJECT')):
     with Progress(
             SpinnerColumn(),
@@ -84,8 +86,10 @@ def play(recording_session: str = typer.Argument(..., help="Recording session id
     ) as progress:
         rest.ensure_auth_token()
         v = progress.add_task(description=f"Verifying broker {broker} exists...", total=100)
+        r = rest.handle_get(url=f'/api/project/{project}/brokers/{broker}',
+                            return_response=True,
+                            allow_status_codes=[404])
 
-        r = requests.get(f'{rest.base_url}/api/project/{project}/brokers/{broker}', headers=rest.headers, )
         progress.update(v, advance=100.0)
         if r.status_code == 404:
             if ensure_broker_started:
@@ -108,7 +112,7 @@ def play(recording_session: str = typer.Argument(..., help="Recording session id
         #    rest.handle_get(f"/api/project/{project}/files/recording/{recording_session}/upload",
         #                    params={'brokerName': broker})
         # else:
-        broker_config_query=""
+        broker_config_query = ""
         if (broker_config_name != "default"):
             broker_config_query = f"?brokerConfigName={broker_config_name}"
 
@@ -119,7 +123,8 @@ def play(recording_session: str = typer.Argument(..., help="Recording session id
 @app.command(help="Downloads the specified recording file to disk")
 def download_recording_file(
         recording_file_name: str = typer.Argument(..., help="Recording file to download"),
-        recording_session: str = typer.Option(..., help="Recording session id that this file belongs to", envvar='REMOTIVE_CLOUD_RECORDING_SESSION'),
+        recording_session: str = typer.Option(..., help="Recording session id that this file belongs to",
+                                              envvar='REMOTIVE_CLOUD_RECORDING_SESSION'),
         project: str = typer.Option(..., help="Project ID", envvar='REMOTIVE_CLOUD_PROJECT')):
     with Progress(
             SpinnerColumn(),
@@ -162,16 +167,20 @@ def delete(recording_session: str = typer.Argument(..., help="Recording session
 
 @app.command(name="delete-recording-file")
 def delete_recording_file(recording_file_name: str = typer.Argument(..., help="Recording file to download"),
-           recording_session: str = typer.Option(..., help="Recording session id that this file belongs to", envvar='REMOTIVE_CLOUD_RECORDING_SESSION'),
-           project: str = typer.Option(..., help="Project ID", envvar='REMOTIVE_CLOUD_PROJECT')):
+                          recording_session: str = typer.Option(...,
+                                                                help="Recording session id that this file belongs to",
+                                                                envvar='REMOTIVE_CLOUD_RECORDING_SESSION'),
+                          project: str = typer.Option(..., help="Project ID", envvar='REMOTIVE_CLOUD_PROJECT')):
     """
     Deletes the specified recording file
 
     """
-    rest.handle_delete(f'/api/project/{project}/files/recording/{recording_session}/recording-file/{recording_file_name}')
+    rest.handle_delete(
+        f'/api/project/{project}/files/recording/{recording_session}/recording-file/{recording_file_name}')
+
 
 @app.command()
-def upload(path: str  = typer.Argument(..., help="Path to valid recording to upload"),
+def upload(path: str = typer.Argument(..., help="Path to valid recording to upload"),
            project: str = typer.Option(..., help="Project ID", envvar='REMOTIVE_CLOUD_PROJECT')):
     with Progress(
             SpinnerColumn(),
@@ -193,10 +202,12 @@ def upload(path: str  = typer.Argument(..., help="Path to valid recording to upl
         else:
             print(r.text)
 
+
 @app.command()
 def upload_broker_configuration(
-        directory:str = typer.Argument(..., help="Configuration directory"),
-        recording_session: str = typer.Option(..., help="Recording session id", envvar='REMOTIVE_CLOUD_RECORDING_SESSION'),
+        directory: str = typer.Argument(..., help="Configuration directory"),
+        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")
 ):
@@ -214,7 +225,7 @@ def upload_broker_configuration(
         # 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(directory + '**/**', recursive=True)))
         if len(files) == 0:
             sys.stderr.write("No interfaces.json found in directory, this file is required")
             raise typer.Exit(1)
@@ -227,15 +238,18 @@ def upload_broker_configuration(
         # Get the current details about broker configurations to see if a config with this
         # name already exists
         #
-        task=progress.add_task(description=f"Preparing upload of {broker_config_dir_name}", total=1)
-        details_resp=rest.handle_get(f"/api/project/{project}/files/recording/{recording_session}", return_response=True)
-        details=details_resp.json()
+        task = progress.add_task(description=f"Preparing upload of {broker_config_dir_name}", total=1)
+        details_resp = rest.handle_get(f"/api/project/{project}/files/recording/{recording_session}",
+                                       return_response=True)
+        details = details_resp.json()
         existing_configs = details['brokerConfigurations']
         if (len(existing_configs) > 0):
-            data=list(filter(lambda x : x['name'] == broker_config_dir_name, existing_configs))
+            data = list(filter(lambda x: x['name'] == broker_config_dir_name, existing_configs))
             if len(data) > 0:
                 if (overwrite):
-                    rest.handle_delete(f'/api/project/{project}/files/recording/{recording_session}/configuration/{broker_config_dir_name}', quiet=True)
+                    rest.handle_delete(
+                        f'/api/project/{project}/files/recording/{recording_session}/configuration/{broker_config_dir_name}',
+                        quiet=True)
                 else:
                     sys.stderr.write("Broker configuration already exists, use --overwrite to replace\n")
                     raise typer.Exit(1)
@@ -244,26 +258,29 @@ def upload_broker_configuration(
         # From the list of files, create a tuple of local_path to the actual file
         # and a remote path as it should be stored in cloud
         #
-        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)))
+        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)))
 
         #
         # convert this remote paths and ask cloud to prepare upload urls for those
         #
         json_request_upload_urls_req = {
-            'name' : 'not_used',
-            'paths' : list(map(lambda x: x['remote_path'], file_infos))
+            'name': 'not_used',
+            'paths': list(map(lambda x: x['remote_path'], file_infos))
         }
 
-        response = rest.handle_put(url = f'/api/project/{project}/files/recording/{recording_session}/configuration', return_response=True, body=json.dumps(json_request_upload_urls_req))
+        response = rest.handle_put(url=f'/api/project/{project}/files/recording/{recording_session}/configuration',
+                                   return_response=True, body=json.dumps(json_request_upload_urls_req))
         if (response.status_code != 200):
             print(f'Failed to prepare configuration upload')
             print(f'{response.text} - {response.status_code}')
             raise typer.Exit(1)
         progress.update(task, advance=1)
 
-        task=progress.add_task(description=f"Uploading {broker_config_dir_name} ({len(file_infos)} files)", total=len(file_infos))
+        task = progress.add_task(description=f"Uploading {broker_config_dir_name} ({len(file_infos)} files)",
+                                 total=len(file_infos))
 
         #
         # Upload urls is a  remote_path : upload_url dict
@@ -273,12 +290,12 @@ def upload_broker_configuration(
 
         # For each file - upload
         for file in file_infos:
-            key=file['remote_path']
-            path=file['local_path']
-            url=upload_urls[key]
-            upload_task=progress.add_task(description=f"Uploading {key}", total=1)
-            headers={
-                'Content-Type' : "application/x-www-form-urlencoded"
+            key = file['remote_path']
+            path = file['local_path']
+            url = upload_urls[key]
+            upload_task = progress.add_task(description=f"Uploading {key}", total=1)
+            headers = {
+                'Content-Type': "application/x-www-form-urlencoded"
             }
             r = requests.put(url, open(path, 'rb'), headers=headers)
             progress.update(task, advance=1)
@@ -292,11 +309,11 @@ def upload_broker_configuration(
         print(f"Successfully uploaded broker configuration {broker_config_dir_name}")
 
 
-
 @app.command(help="Downloads the specified broker configuration directory as zip file")
 def download_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'),
+        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')
 ):
     rest.ensure_auth_token()
@@ -311,18 +328,18 @@ def download_configuration(
     open(filename, 'wb').write(r.content)
     print(f'Downloaded file {filename}')
 
+
 @app.command(help="Downloads the specified broker configuration directory as zip file")
 def delete_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'),
+        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')
 ):
-
     rest.handle_delete(
         url=f"/api/project/{project}/files/recording/{recording_session}/configuration/{broker_config_name}")
 
 
-
 def get_filename_from_cd(cd):
     """
     Get filename from content-disposition

{remotivelabs_cli-0.0.1a35 → remotivelabs_cli-0.0.1a36}/cli/cloud/rest_helper.py

@@ -4,6 +4,7 @@ import requests
 import os
 import json
 import logging
+from typing import List
 from pathlib import Path
 from os.path import exists
 import typer
@@ -64,14 +65,14 @@ def ensure_auth_token():
     }
 
 
-def handle_get(url, params=None, return_response: bool = False):
+def handle_get(url, params=None, return_response: bool = False, allow_status_codes=None):
     if params is None:
         params = {}
     ensure_auth_token()
     r = requests.get(f'{base_url}{url}', headers=headers, params=params)
 
     if return_response:
-        check_api_result(r)
+        check_api_result(r, allow_status_codes)
         return r
     print_api_result(r)
 
@@ -85,8 +86,12 @@ def has_access(url, params={}):
         return True
 
 
-def check_api_result(response):
+def check_api_result(response, allow_status_codes: List[int] = None):
+
     if response.status_code > 299:
+
+        if allow_status_codes is not None and  response.status_code in allow_status_codes:
+            return
         err_console.print(f':boom: [bold red]Got status code[/bold red]: {response.status_code}')
         if response.status_code == 401:
             err_console.print("Your token has expired, please login again")

{remotivelabs_cli-0.0.1a35 → remotivelabs_cli-0.0.1a36}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "remotivelabs-cli"
-version = "0.0.1.alpha35"
+version = "0.0.1.alpha36"
 description = ""
 authors = ["Johan Rask <johan.rask@remotivelabs.com>"]
 readme = "README.md"