outerbounds 0.3.87__py3-none-any.whl → 0.3.87rc0__py3-none-any.whl

outerbounds/command_groups/apps_cli.py

@@ -0,0 +1,511 @@
+import base64
+import hashlib
+import json
+import os
+import re
+import subprocess
+import sys
+import zlib
+from base64 import b64decode, b64encode
+from importlib.machinery import PathFinder
+from os import path
+from pathlib import Path
+from typing import Any, Callable, Dict, List
+from outerbounds._vendor import click
+import requests
+from requests.exceptions import HTTPError
+
+from ..utils import metaflowconfig
+from ..utils.schema import (
+    CommandStatus,
+    OuterboundsCommandResponse,
+    OuterboundsCommandStatus,
+)
+
+
+@click.group()
+def cli(**kwargs):
+    pass
+
+
+@click.group(help="Manage perimeters")
+def app(**kwargs):
+    pass
+
+
+@app.command(help="Start an app using a port and a name")
+@click.option(
+    "-d",
+    "--config-dir",
+    default=path.expanduser(os.environ.get("METAFLOW_HOME", "~/.metaflowconfig")),
+    help="Path to Metaflow configuration directory",
+    show_default=True,
+)
+@click.option(
+    "-p",
+    "--profile",
+    default=os.environ.get("METAFLOW_PROFILE", ""),
+    help="The named metaflow profile in which your workstation exists",
+)
+@click.option(
+    "--port",
+    required=True,
+    help="Port number where you want to start your app.",
+    type=int,
+)
+@click.option(
+    "--name",
+    required=True,
+    help="Name of your app",
+    type=str,
+)
+@click.option(
+    "-o",
+    "--output",
+    default="",
+    help="Show output in the specified format.",
+    type=click.Choice(["json", ""]),
+)
+def start(config_dir=None, profile=None, port=-1, name="", output=""):
+    start_app_response = OuterboundsCommandResponse()
+
+    validate_workstation_step = CommandStatus(
+        "ValidateRunningOnWorkstation",
+        OuterboundsCommandStatus.OK,
+        "Command is being run on a workstation.",
+    )
+
+    list_workstations_step = CommandStatus(
+        "ListWorkstations",
+        OuterboundsCommandStatus.OK,
+        "List of workstations fetched.",
+    )
+
+    validate_port_exists = CommandStatus(
+        "ValidatePortExists",
+        OuterboundsCommandStatus.OK,
+        "Port exists on workstation",
+    )
+
+    start_app_step = CommandStatus(
+        "StartApp",
+        OuterboundsCommandStatus.OK,
+        f"App {name} started on port {port}!",
+    )
+
+    if "WORKSTATION_ID" not in os.environ:
+        validate_workstation_step.update(
+            OuterboundsCommandStatus.FAIL,
+            "All outerbounds app commands can only be run from a workstation.",
+            "",
+        )
+        start_app_response.add_step(validate_workstation_step)
+        click.secho(
+            "All outerbounds app commands can only be run from a workstation.",
+            fg="red",
+            err=True,
+        )
+
+        if output == "json":
+            click.echo(json.dumps(start_app_response.as_dict(), indent=4))
+        return
+
+    try:
+        try:
+            metaflow_token = metaflowconfig.get_metaflow_token_from_config(
+                config_dir, profile
+            )
+            api_url = metaflowconfig.get_sanitized_url_from_config(
+                config_dir, profile, "OBP_API_SERVER"
+            )
+
+            workstations_response = requests.get(
+                f"{api_url}/v1/workstations", headers={"x-api-key": metaflow_token}
+            )
+            workstations_response.raise_for_status()
+            start_app_response.add_step(list_workstations_step)
+        except:
+            click.secho("Failed to list workstations!", fg="red", err=True)
+            list_workstations_step.update(
+                OuterboundsCommandStatus.FAIL, "Failed to list workstations!", ""
+            )
+            start_app_response.add_step(list_workstations_step)
+            if output == "json":
+                click.echo(json.dumps(start_app_response.as_dict(), indent=4))
+            return
+
+        workstations_json = workstations_response.json()["workstations"]
+        for workstation in workstations_json:
+            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:
+                            start_app_response.add_step(validate_port_exists)
+                            if named_port["enabled"] and named_port["name"] == name:
+                                click.secho(
+                                    f"App {name} started on port {port}!",
+                                    fg="green",
+                                    err=True,
+                                )
+                                start_app_response.add_step(start_app_step)
+                                if output == "json":
+                                    click.echo(
+                                        json.dumps(
+                                            start_app_response.as_dict(), indent=4
+                                        )
+                                    )
+                                return
+                            else:
+                                try:
+                                    response = requests.put(
+                                        f"{api_url}/v1/workstations/update/{os.environ['WORKSTATION_ID']}/namedports",
+                                        headers={"x-api-key": metaflow_token},
+                                        json={
+                                            "port": port,
+                                            "name": name,
+                                            "enabled": True,
+                                        },
+                                    )
+
+                                    response.raise_for_status()
+                                    click.secho(
+                                        f"App {name} started on port {port}!",
+                                        fg="green",
+                                        err=True,
+                                    )
+                                except:
+                                    click.secho(
+                                        f"Failed to start app {name} on port {port}!",
+                                        fg="red",
+                                        err=True,
+                                    )
+                                    start_app_step.update(
+                                        OuterboundsCommandStatus.FAIL,
+                                        f"Failed to start app {name} on port {port}!",
+                                        "",
+                                    )
+
+                                start_app_response.add_step(start_app_step)
+                                if output == "json":
+                                    click.echo(
+                                        json.dumps(
+                                            start_app_response.as_dict(), indent=4
+                                        )
+                                    )
+                                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(
+            OuterboundsCommandStatus.FAIL,
+            f"Failed to start app {name} on port {port}!",
+            "",
+        )
+        start_app_response.add_step(start_app_step)
+        if output == "json":
+            click.secho(json.dumps(start_app_response.as_dict(), indent=4))
+
+
+@app.command(help="Stop an app using its port number")
+@click.option(
+    "-d",
+    "--config-dir",
+    default=path.expanduser(os.environ.get("METAFLOW_HOME", "~/.metaflowconfig")),
+    help="Path to Metaflow configuration directory",
+    show_default=True,
+)
+@click.option(
+    "-p",
+    "--profile",
+    default=os.environ.get("METAFLOW_PROFILE", ""),
+    help="The named metaflow profile in which your workstation exists",
+)
+@click.option(
+    "--port",
+    required=True,
+    help="Port number where you want to start your app.",
+    type=int,
+)
+@click.option(
+    "-o",
+    "--output",
+    default="",
+    help="Show output in the specified format.",
+    type=click.Choice(["json", ""]),
+)
+def stop(config_dir=None, profile=None, port=-1, output=""):
+    stop_app_response = OuterboundsCommandResponse()
+
+    validate_workstation_step = CommandStatus(
+        "ValidateRunningOnWorkstation",
+        OuterboundsCommandStatus.OK,
+        "Command is being run on a workstation.",
+    )
+
+    list_workstations_step = CommandStatus(
+        "ListWorkstations",
+        OuterboundsCommandStatus.OK,
+        "List of workstations fetched.",
+    )
+
+    validate_port_exists = CommandStatus(
+        "ValidatePortExists",
+        OuterboundsCommandStatus.OK,
+        "Port exists on workstation",
+    )
+
+    stop_app_step = CommandStatus(
+        "StopApp",
+        OuterboundsCommandStatus.OK,
+        f"App stopped on port {port}!",
+    )
+
+    if "WORKSTATION_ID" not in os.environ:
+        validate_workstation_step.update(
+            OuterboundsCommandStatus.FAIL,
+            "All outerbounds app commands can only be run from a workstation.",
+            "",
+        )
+        stop_app_response.add_step(validate_workstation_step)
+        click.secho(
+            "All outerbounds app commands can only be run from a workstation.",
+            fg="red",
+            err=True,
+        )
+
+        if output == "json":
+            click.echo(json.dumps(stop_app_response.as_dict(), indent=4))
+        return
+
+    try:
+        try:
+            metaflow_token = metaflowconfig.get_metaflow_token_from_config(
+                config_dir, profile
+            )
+            api_url = metaflowconfig.get_sanitized_url_from_config(
+                config_dir, profile, "OBP_API_SERVER"
+            )
+
+            workstations_response = requests.get(
+                f"{api_url}/v1/workstations", headers={"x-api-key": metaflow_token}
+            )
+            workstations_response.raise_for_status()
+            stop_app_response.add_step(list_workstations_step)
+        except:
+            click.secho("Failed to list workstations!", fg="red", err=True)
+            list_workstations_step.update(
+                OuterboundsCommandStatus.FAIL, "Failed to list workstations!", ""
+            )
+            stop_app_response.add_step(list_workstations_step)
+            if output == "json":
+                click.echo(json.dumps(stop_app_response.as_dict(), indent=4))
+            return
+
+        workstations_json = workstations_response.json()["workstations"]
+        for workstation in workstations_json:
+            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:
+                            stop_app_response.add_step(validate_port_exists)
+                            if not named_port["enabled"]:
+                                click.secho(
+                                    f"App stopped on port {port}!", fg="green", err=True
+                                )
+                                stop_app_response.add_step(stop_app_step)
+                                if output == "json":
+                                    click.echo(
+                                        json.dumps(
+                                            stop_app_response.as_dict(), indent=4
+                                        )
+                                    )
+                                return
+                            else:
+                                try:
+                                    response = requests.put(
+                                        f"{api_url}/v1/workstations/update/{os.environ['WORKSTATION_ID']}/namedports",
+                                        headers={"x-api-key": metaflow_token},
+                                        json={
+                                            "port": port,
+                                            "name": named_port["name"],
+                                            "enabled": False,
+                                        },
+                                    )
+                                    response.raise_for_status()
+                                    click.secho(
+                                        f"App stopped on port {port}!",
+                                        fg="green",
+                                        err=True,
+                                    )
+                                except:
+                                    click.secho(
+                                        f"Failed to stop app on port {port}!",
+                                        fg="red",
+                                        err=True,
+                                    )
+                                    stop_app_step.update(
+                                        OuterboundsCommandStatus.FAIL,
+                                        f"Failed to stop app on port {port}!",
+                                        "",
+                                    )
+
+                                stop_app_response.add_step(stop_app_step)
+                                if output == "json":
+                                    click.echo(
+                                        json.dumps(
+                                            stop_app_response.as_dict(), indent=4
+                                        )
+                                    )
+                                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']}",
+            "",
+        )
+        stop_app_response.add_step(validate_port_exists)
+        if output == "json":
+            click.echo(json.dumps(stop_app_response.as_dict(), indent=4))
+    except Exception as e:
+        click.secho(f"Failed to stop app on port {port}!", fg="red", err=True)
+        stop_app_step.update(
+            OuterboundsCommandStatus.FAIL, f"Failed to stop on port {port}!", ""
+        )
+        stop_app_response.add_step(stop_app_step)
+        if output == "json":
+            click.echo(json.dumps(stop_app_response.as_dict(), indent=4))
+
+
+@app.command(help="Stop an app using its port number")
+@click.option(
+    "-d",
+    "--config-dir",
+    default=path.expanduser(os.environ.get("METAFLOW_HOME", "~/.metaflowconfig")),
+    help="Path to Metaflow configuration directory",
+    show_default=True,
+)
+@click.option(
+    "-p",
+    "--profile",
+    default=os.environ.get("METAFLOW_PROFILE", ""),
+    help="The named metaflow profile in which your workstation exists",
+)
+@click.option(
+    "-o",
+    "--output",
+    default="",
+    help="Show output in the specified format.",
+    type=click.Choice(["json", ""]),
+)
+def list(config_dir=None, profile=None, output=""):
+    list_app_response = OuterboundsCommandResponse()
+
+    validate_workstation_step = CommandStatus(
+        "ValidateRunningOnWorkstation",
+        OuterboundsCommandStatus.OK,
+        "Command is being run on a workstation.",
+    )
+
+    list_workstations_step = CommandStatus(
+        "ListWorkstations",
+        OuterboundsCommandStatus.OK,
+        "List of workstations fetched.",
+    )
+
+    if "WORKSTATION_ID" not in os.environ:
+        validate_workstation_step.update(
+            OuterboundsCommandStatus.FAIL,
+            "All outerbounds app commands can only be run from a workstation.",
+            "",
+        )
+        list_app_response.add_step(validate_workstation_step)
+        click.secho(
+            "All outerbounds app commands can only be run from a workstation.",
+            fg="red",
+            err=True,
+        )
+
+        if output == "json":
+            click.echo(json.dumps(list_app_response.as_dict(), indent=4))
+        return
+
+    try:
+        try:
+            metaflow_token = metaflowconfig.get_metaflow_token_from_config(
+                config_dir, profile
+            )
+            api_url = metaflowconfig.get_sanitized_url_from_config(
+                config_dir, profile, "OBP_API_SERVER"
+            )
+
+            workstations_response = requests.get(
+                f"{api_url}/v1/workstations", headers={"x-api-key": metaflow_token}
+            )
+            workstations_response.raise_for_status()
+            list_app_response.add_step(list_workstations_step)
+        except:
+            click.secho("Failed to list workstations!", fg="red", err=True)
+            list_workstations_step.update(
+                OuterboundsCommandStatus.FAIL, "Failed to list workstations!", ""
+            )
+            list_app_response.add_step(list_workstations_step)
+            if output == "json":
+                click.echo(json.dumps(list_app_response.as_dict(), indent=4))
+            return
+
+        workstations_json = workstations_response.json()["workstations"]
+        for workstation in workstations_json:
+            if workstation["instance_id"] == os.environ["WORKSTATION_ID"]:
+                if "named_ports" in workstation["spec"]:
+                    for named_port in workstation["spec"]["named_ports"]:
+                        if named_port["enabled"]:
+                            click.secho(
+                                f"App Name: {named_port['name']}", fg="green", err=True
+                            )
+                            click.secho(
+                                f"App Port on Workstation: {named_port['port']}",
+                                fg="green",
+                                err=True,
+                            )
+                            click.secho(f"App Status: Deployed", fg="green", err=True)
+                            click.secho(
+                                f"App URL: {api_url.replace('api', 'ui')}/apps/{os.environ['WORKSTATION_ID']}/{named_port['name']}/",
+                                fg="green",
+                                err=True,
+                            )
+                        else:
+                            click.secho(
+                                f"App Port on Workstation: {named_port['port']}",
+                                fg="yellow",
+                                err=True,
+                            )
+                            click.secho(
+                                f"App Status: Not Deployed", fg="yellow", err=True
+                            )
+
+                        click.echo("\n", err=True)
+    except Exception as e:
+        click.secho(f"Failed to list apps!", fg="red", err=True)
+        if output == "json":
+            click.echo(json.dumps(list_app_response.as_dict(), indent=4))
+
+
+cli.add_command(app, name="app")

outerbounds/command_groups/cli.py

@@ -2,11 +2,17 @@ from outerbounds._vendor import click
 from . import local_setup_cli
 from . import workstations_cli
 from . import perimeters_cli
+from . import apps_cli
 
 
 @click.command(
     cls=click.CommandCollection,
-    sources=[local_setup_cli.cli, workstations_cli.cli, perimeters_cli.cli],
+    sources=[
+        local_setup_cli.cli,
+        workstations_cli.cli,
+        perimeters_cli.cli,
+        apps_cli.cli,
+    ],
 )
 def cli(**kwargs):
     pass

outerbounds/utils/schema.py

@@ -59,14 +59,14 @@ class OuterboundsCommandResponse:
         if step.status == OuterboundsCommandStatus.FAIL:
             self.status = OuterboundsCommandStatus.FAIL
             self._code = 500
-            self._message = "We found one or more errors with your installation."
+            self._message = "Encountered an error when trying to run command."
         elif (
             step.status == OuterboundsCommandStatus.WARN
             and self.status != OuterboundsCommandStatus.FAIL
         ):
             self.status = OuterboundsCommandStatus.WARN
             self._code = 200
-            self._message = "We found one or more warnings with your installation."
+            self._message = "Encountered one or more warnings when running the command."
 
     def as_dict(self):
         self._data["steps"] = [step.as_dict() for step in self._steps]

{outerbounds-0.3.87.dist-info → outerbounds-0.3.87rc0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: outerbounds
-Version: 0.3.87
+Version: 0.3.87rc0
 Summary: More Data Science, Less Administration
 License: Proprietary
 Keywords: data science,machine learning,MLOps
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Provides-Extra: apps
 Provides-Extra: azure
 Provides-Extra: gcp
 Requires-Dist: azure-identity (>=1.15.0,<2.0.0) ; extra == "azure"

{outerbounds-0.3.87.dist-info → outerbounds-0.3.87rc0.dist-info}/RECORD

@@ -41,16 +41,17 @@ 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/cli.py,sha256=sorDdQvmTPqIwfvgtuNLILelimXu5CknFnWQFsYFGHs,286
+outerbounds/command_groups/apps_cli.py,sha256=924nZKqZuE0kokMfz4woSI8hx47l7ss7-831ETccUXE,19340
+outerbounds/command_groups/cli.py,sha256=3NyxnczfANtxKh-KnJHGWAEC5akdXux_hylfGXTs2A0,362
 outerbounds/command_groups/local_setup_cli.py,sha256=somQMeLgRSK8BAje2rN6LeY-lszXmwBpNLvDCk293h8,36554
 outerbounds/command_groups/perimeters_cli.py,sha256=vU1LykO9T2Xj4Fn8hyhaCUR4q454q1aVoU4XhhrgAS4,12781
 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
 outerbounds/utils/metaflowconfig.py,sha256=Ja1eufYm4UANRNpk7qlxg_UUudToDOVCjaWg88N-xhQ,3538
-outerbounds/utils/schema.py,sha256=cNlgjmteLPbDzSEUSQDsq8txdhMGyezSmM83jU3aa0w,2329
+outerbounds/utils/schema.py,sha256=lMUr9kNgn9wy-sO_t_Tlxmbt63yLeN4b0xQXbDUDj4A,2331
 outerbounds/vendor.py,sha256=gRLRJNXtZBeUpPEog0LOeIsl6GosaFFbCxUvR4bW6IQ,5093
-outerbounds-0.3.87.dist-info/entry_points.txt,sha256=7ye0281PKlvqxu15rjw60zKg2pMsXI49_A8BmGqIqBw,47
-outerbounds-0.3.87.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
-outerbounds-0.3.87.dist-info/METADATA,sha256=EFZdu76YljG2LKp8ZQZcKcyWAsVg_O_m335BmfcfKjo,1632
-outerbounds-0.3.87.dist-info/RECORD,,
+outerbounds-0.3.87rc0.dist-info/entry_points.txt,sha256=7ye0281PKlvqxu15rjw60zKg2pMsXI49_A8BmGqIqBw,47
+outerbounds-0.3.87rc0.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
+outerbounds-0.3.87rc0.dist-info/METADATA,sha256=av38VP4Z6_FUni7QysM7NjtLY2vzM_6vnGA8juq8rFM,1656
+outerbounds-0.3.87rc0.dist-info/RECORD,,