outerbounds 0.3.92__py3-none-any.whl → 0.3.94__py3-none-any.whl

outerbounds/command_groups/apps_cli.py

@@ -17,7 +17,7 @@ def cli(**kwargs):
     pass
 
 
-@click.group(help="Manage perimeters")
+@click.group(help="Manage apps")
 def app(**kwargs):
     pass
 
@@ -56,6 +56,21 @@ def app(**kwargs):
     type=click.Choice(["json", ""]),
 )
 def start(config_dir=None, profile=None, port=-1, name="", output=""):
+    if len(name) == 0 or len(name) >= 20:
+        click.secho(
+            "App name should not be more than 20 characters long.",
+            fg="red",
+            err=True,
+        )
+        return
+    elif not name.isalnum() or not name.islower():
+        click.secho(
+            "App name can only contain lowercase alphanumeric characters.",
+            fg="red",
+            err=True,
+        )
+        return
+
     start_app_response = OuterboundsCommandResponse()
 
     validate_workstation_step = CommandStatus(
@@ -70,10 +85,10 @@ def start(config_dir=None, profile=None, port=-1, name="", output=""):
         "List of workstations fetched.",
     )
 
-    validate_port_exists = CommandStatus(
-        "ValidatePortExists",
+    validate_request = CommandStatus(
+        "ValidateRequest",
         OuterboundsCommandStatus.OK,
-        "Port exists on workstation",
+        "Start app request is valid.",
     )
 
     start_app_step = CommandStatus(
@@ -127,12 +142,36 @@ def start(config_dir=None, profile=None, port=-1, name="", output=""):
         for workstation in workstations_json:
             if workstation["instance_id"] == os.environ["WORKSTATION_ID"]:
                 if "named_ports" in workstation["spec"]:
+                    try:
+                        ensure_app_start_request_is_valid(
+                            workstation["spec"]["named_ports"], port, name
+                        )
+                    except ValueError as e:
+                        click.secho(str(e), fg="red", err=True)
+                        validate_request.update(
+                            OuterboundsCommandStatus.FAIL,
+                            str(e),
+                            "",
+                        )
+                        start_app_response.add_step(validate_request)
+                        if output == "json":
+                            click.echo(
+                                json.dumps(start_app_response.as_dict(), indent=4)
+                            )
+                        return
+
+                    start_app_response.add_step(validate_request)
+
                     for named_port in workstation["spec"]["named_ports"]:
                         if int(named_port["port"]) == port:
-                            start_app_response.add_step(validate_port_exists)
-                            if named_port["enabled"] and named_port["name"] == name:
+                            if named_port["enabled"]:
+                                already_running_message = (
+                                    f"App {name} already running on port {port}!"
+                                    if named_port["name"] == name
+                                    else f"App {named_port['name']} already running on port {port} is now renamed to {name}!"
+                                )
                                 click.secho(
-                                    f"App {name} started on port {port}!",
+                                    already_running_message,
                                     fg="green",
                                     err=True,
                                 )
@@ -167,7 +206,12 @@ def start(config_dir=None, profile=None, port=-1, name="", output=""):
                                         fg="green",
                                         err=True,
                                     )
-                                except:
+                                    click.secho(
+                                        f"App URL: {api_url.replace('api', 'ui')}/apps/{os.environ['WORKSTATION_ID']}/{name}/",
+                                        fg="green",
+                                        err=True,
+                                    )
+                                except Exception:
                                     click.secho(
                                         f"Failed to start app {name} on port {port}!",
                                         fg="red",
@@ -187,20 +231,6 @@ def start(config_dir=None, profile=None, port=-1, name="", output=""):
                                         )
                                     )
                                 return
-
-        click.secho(
-            f"Port {port} not found on workstation {os.environ['WORKSTATION_ID']}",
-            fg="red",
-            err=True,
-        )
-        validate_port_exists.update(
-            OuterboundsCommandStatus.FAIL,
-            f"Port {port} not found on workstation {os.environ['WORKSTATION_ID']}",
-            "",
-        )
-        start_app_response.add_step(validate_port_exists)
-        if output == "json":
-            click.echo(json.dumps(start_app_response.as_dict(), indent=4))
     except Exception as e:
         click.secho(f"Failed to start app {name} on port {port}!", fg="red", err=True)
         start_app_step.update(
@@ -229,10 +259,18 @@ def start(config_dir=None, profile=None, port=-1, name="", output=""):
 )
 @click.option(
     "--port",
-    required=True,
+    required=False,
+    default=-1,
     help="Port number where you want to start your app.",
     type=int,
 )
+@click.option(
+    "--name",
+    required=False,
+    help="Name of your app",
+    default="",
+    type=str,
+)
 @click.option(
     "-o",
     "--output",
@@ -240,7 +278,22 @@ def start(config_dir=None, profile=None, port=-1, name="", output=""):
     help="Show output in the specified format.",
     type=click.Choice(["json", ""]),
 )
-def stop(config_dir=None, profile=None, port=-1, output=""):
+def stop(config_dir=None, profile=None, port=-1, name="", output=""):
+    if port == -1 and not name:
+        click.secho(
+            "Please provide either a port number or a name to stop the app.",
+            fg="red",
+            err=True,
+        )
+        return
+    elif port > 0 and name:
+        click.secho(
+            "Please provide either a port number or a name to stop the app, not both.",
+            fg="red",
+            err=True,
+        )
+        return
+
     stop_app_response = OuterboundsCommandResponse()
 
     validate_workstation_step = CommandStatus(
@@ -313,11 +366,21 @@ def stop(config_dir=None, profile=None, port=-1, output=""):
             if workstation["instance_id"] == os.environ["WORKSTATION_ID"]:
                 if "named_ports" in workstation["spec"]:
                     for named_port in workstation["spec"]["named_ports"]:
-                        if int(named_port["port"]) == port:
+                        if (
+                            int(named_port["port"]) == port
+                            or named_port["name"] == name
+                        ):
                             stop_app_response.add_step(validate_port_exists)
                             if not named_port["enabled"]:
+                                already_stopped_message = (
+                                    f"No deployed app named {named_port['name']} found."
+                                    if name
+                                    else f"There is no app deployed on port {port}"
+                                )
                                 click.secho(
-                                    f"App stopped on port {port}!", fg="green", err=True
+                                    already_stopped_message,
+                                    fg="green",
+                                    err=True,
                                 )
                                 stop_app_response.add_step(stop_app_step)
                                 if output == "json":
@@ -333,26 +396,26 @@ def stop(config_dir=None, profile=None, port=-1, output=""):
                                         f"{api_url}/v1/workstations/update/{os.environ['WORKSTATION_ID']}/namedports",
                                         headers={"x-api-key": metaflow_token},
                                         json={
-                                            "port": port,
+                                            "port": named_port["port"],
                                             "name": named_port["name"],
                                             "enabled": False,
                                         },
                                     )
                                     response.raise_for_status()
                                     click.secho(
-                                        f"App stopped on port {port}!",
+                                        f"App {named_port['name']} stopped on port {named_port['port']}!",
                                         fg="green",
                                         err=True,
                                     )
-                                except:
+                                except Exception as e:
                                     click.secho(
-                                        f"Failed to stop app on port {port}!",
+                                        f"Failed to stop app {named_port['name']} on port {named_port['port']}!",
                                         fg="red",
                                         err=True,
                                     )
                                     stop_app_step.update(
                                         OuterboundsCommandStatus.FAIL,
-                                        f"Failed to stop app on port {port}!",
+                                        f"Failed to stop app {named_port['name']} on port {named_port['port']}!",
                                         "",
                                     )
 
@@ -365,14 +428,21 @@ def stop(config_dir=None, profile=None, port=-1, output=""):
                                     )
                                 return
 
+        err_message = (
+            (f"Port {port} not found on workstation {os.environ['WORKSTATION_ID']}")
+            if port != -1
+            else f"App {name} not found on workstation {os.environ['WORKSTATION_ID']}"
+        )
+
         click.secho(
-            f"Port {port} not found on workstation {os.environ['WORKSTATION_ID']}",
+            err_message,
             fg="red",
             err=True,
         )
+
         validate_port_exists.update(
             OuterboundsCommandStatus.FAIL,
-            f"Port {port} not found on workstation {os.environ['WORKSTATION_ID']}",
+            err_message,
             "",
         )
         stop_app_response.add_step(validate_port_exists)
@@ -502,4 +572,21 @@ def list(config_dir=None, profile=None, output=""):
             click.echo(json.dumps(list_app_response.as_dict(), indent=4))
 
 
+def ensure_app_start_request_is_valid(existing_named_ports, port: int, name: str):
+    existing_apps_by_port = {np["port"]: np for np in existing_named_ports}
+
+    if port not in existing_apps_by_port:
+        raise ValueError(f"Port {port} not found on workstation")
+
+    for existing_named_port in existing_named_ports:
+        if (
+            name == existing_named_port["name"]
+            and existing_named_port["port"] != port
+            and existing_named_port["enabled"]
+        ):
+            raise ValueError(
+                f"App with name '{name}' is already deployed on port {existing_named_port['port']}"
+            )
+
+
 cli.add_command(app, name="app")

outerbounds/command_groups/cli.py

@@ -1,8 +1,5 @@
 from outerbounds._vendor import click
-from . import local_setup_cli
-from . import workstations_cli
-from . import perimeters_cli
-from . import apps_cli
+from . import local_setup_cli, workstations_cli, perimeters_cli, apps_cli, tutorials_cli
 
 
 @click.command(
@@ -12,6 +9,7 @@ from . import apps_cli
         workstations_cli.cli,
         perimeters_cli.cli,
         apps_cli.cli,
+        tutorials_cli.cli,
     ],
 )
 def cli(**kwargs):

outerbounds/command_groups/tutorials_cli.py

@@ -0,0 +1,111 @@
+import os
+from outerbounds._vendor import click
+import requests
+
+import tarfile
+import hashlib
+import tempfile
+
+
+@click.group()
+def cli(**kwargs):
+    pass
+
+
+@click.group(help="Manage tutorials curated by Outerbounds.", hidden=True)
+def tutorials(**kwargs):
+    pass
+
+
+@tutorials.command(help="Pull Outerbounds tutorials.")
+@click.option(
+    "--url",
+    required=True,
+    help="URL to pull the tutorials from.",
+    type=str,
+)
+@click.option(
+    "--destination-dir",
+    help="Show output in the specified format.",
+    type=str,
+    required=True,
+)
+@click.option(
+    "--force-overwrite",
+    is_flag=True,
+    help="Overwrite all existing files across all tutorials.",
+    type=bool,
+    required=False,
+    default=False,
+)
+def pull(url="", destination_dir="", force_overwrite=False):
+    try:
+        secure_download_and_extract(
+            url, destination_dir, force_overwrite=force_overwrite
+        )
+        click.secho("Tutorials pulled successfully.", fg="green", err=True)
+    except Exception as e:
+        print(e)
+        click.secho(f"Failed to pull tutorials: {e}", fg="red", err=True)
+
+
+def secure_download_and_extract(
+    url, dest_dir, expected_hash=None, force_overwrite=False
+):
+    """
+    Download a tar.gz file from a URL, verify its integrity, and extract its contents.
+
+    :param url: URL of the tar.gz file to download
+    :param dest_dir: Destination directory to extract the contents
+    :param expected_hash: Expected SHA256 hash of the file (optional)
+    """
+
+    with tempfile.TemporaryDirectory() as temp_dir:
+        temp_file = os.path.join(
+            temp_dir, hashlib.md5(url.encode()).hexdigest() + ".tar.gz"
+        )
+
+        # Download the file
+        try:
+            response = requests.get(url, stream=True, verify=True)
+            response.raise_for_status()
+
+            with open(temp_file, "wb") as f:
+                for chunk in response.iter_content(chunk_size=8192):
+                    f.write(chunk)
+        except requests.exceptions.RequestException as e:
+            raise Exception(f"Failed to download file: {e}")
+
+        if expected_hash:
+            with open(temp_file, "rb") as f:
+                file_hash = hashlib.sha256(f.read()).hexdigest()
+            if file_hash != expected_hash:
+                raise Exception("File integrity check failed")
+
+        os.makedirs(dest_dir, exist_ok=True)
+
+        try:
+            with tarfile.open(temp_file, "r:gz") as tar:
+                # Keep track of new journeys to extract.
+                to_extract = []
+                members = tar.getmembers()
+                for member in members:
+                    member_path = os.path.join(dest_dir, member.name)
+                    # Check for any files trying to write outside the destination
+                    if not os.path.abspath(member_path).startswith(
+                        os.path.abspath(dest_dir)
+                    ):
+                        raise Exception("Attempted path traversal in tar file")
+                    if not os.path.exists(member_path):
+                        # The user might have modified the existing files, leave them untouched.
+                        to_extract.append(member)
+
+                if force_overwrite:
+                    tar.extractall(path=dest_dir)
+                else:
+                    tar.extractall(path=dest_dir, members=to_extract)
+        except tarfile.TarError as e:
+            raise Exception(f"Failed to extract tar file: {e}")
+
+
+cli.add_command(tutorials, name="tutorials")

{outerbounds-0.3.92.dist-info → outerbounds-0.3.94.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: outerbounds
-Version: 0.3.92
+Version: 0.3.94
 Summary: More Data Science, Less Administration
 License: Proprietary
 Keywords: data science,machine learning,MLOps

{outerbounds-0.3.92.dist-info → outerbounds-0.3.94.dist-info}/RECORD

@@ -41,10 +41,11 @@ outerbounds/_vendor/yaml/serializer.py,sha256=8wFZRy9SsQSktF_f9OOroroqsh4qVUe53r
 outerbounds/_vendor/yaml/tokens.py,sha256=JBSu38wihGr4l73JwbfMA7Ks1-X84g8-NskTz7KwPmA,2578
 outerbounds/cli_main.py,sha256=e9UMnPysmc7gbrimq2I4KfltggyU7pw59Cn9aEguVcU,74
 outerbounds/command_groups/__init__.py,sha256=QPWtj5wDRTINDxVUL7XPqG3HoxHNvYOg08EnuSZB2Hc,21
-outerbounds/command_groups/apps_cli.py,sha256=XdGRitYWyKGDZXlGSbcP7U6F3DclqzgBG7ZGuZK8tzY,19361
-outerbounds/command_groups/cli.py,sha256=3NyxnczfANtxKh-KnJHGWAEC5akdXux_hylfGXTs2A0,362
+outerbounds/command_groups/apps_cli.py,sha256=sgRPYMdL_c7UUcFqy1pTQno0Q2aT1LHT7POB_VUuKoE,22612
+outerbounds/command_groups/cli.py,sha256=q0hdJO4biD3iEOdyJcxnRkeleA8AKAhx842kQ49I6kk,365
 outerbounds/command_groups/local_setup_cli.py,sha256=tuuqJRXQ_guEwOuQSIf9wkUU0yg8yAs31myGViAK15s,36364
 outerbounds/command_groups/perimeters_cli.py,sha256=mrJfFIRYFOjuiz-9h4OKg2JT8Utmbs72z6wvPzDss3s,18685
+outerbounds/command_groups/tutorials_cli.py,sha256=UInFyiMqtscHFfi8YQwiY_6Sdw9quJOtRu5OukEBccw,3522
 outerbounds/command_groups/workstations_cli.py,sha256=V5Jbj1cVb4IRllI7fOgNgL6OekRpuFDv6CEhDb4xC6w,22016
 outerbounds/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 outerbounds/utils/kubeconfig.py,sha256=yvcyRXGR4AhQuqUDqmbGxEOHw5ixMFV0AZIDg1LI_Qo,7981
@@ -52,7 +53,7 @@ outerbounds/utils/metaflowconfig.py,sha256=l2vJbgPkLISU-XPGZFaC8ZKmYFyJemlD6bwB-
 outerbounds/utils/schema.py,sha256=lMUr9kNgn9wy-sO_t_Tlxmbt63yLeN4b0xQXbDUDj4A,2331
 outerbounds/utils/utils.py,sha256=4Z8cszNob_8kDYCLNTrP-wWads_S_MdL3Uj3ju4mEsk,501
 outerbounds/vendor.py,sha256=gRLRJNXtZBeUpPEog0LOeIsl6GosaFFbCxUvR4bW6IQ,5093
-outerbounds-0.3.92.dist-info/entry_points.txt,sha256=7ye0281PKlvqxu15rjw60zKg2pMsXI49_A8BmGqIqBw,47
-outerbounds-0.3.92.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
-outerbounds-0.3.92.dist-info/METADATA,sha256=enOUPH2DJjaqvzpywbTNnD1aosIzZq8JlsBne9w84o8,1632
-outerbounds-0.3.92.dist-info/RECORD,,
+outerbounds-0.3.94.dist-info/entry_points.txt,sha256=7ye0281PKlvqxu15rjw60zKg2pMsXI49_A8BmGqIqBw,47
+outerbounds-0.3.94.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
+outerbounds-0.3.94.dist-info/METADATA,sha256=ipH_wW6z5ITcDg1vBorq7clnY8ajMt-WMBgOcfNbxyA,1632
+outerbounds-0.3.94.dist-info/RECORD,,