outerbounds 0.3.51__py3-none-any.whl → 0.3.52rc0__py3-none-any.whl

outerbounds/command_groups/local_setup_cli.py

@@ -772,3 +772,372 @@ def configure(
     except Exception as e:
         click.secho("Writing the configuration file '{}' failed.".format(writer.path()))
         click.secho("Error: {}".format(str(e)))
+
+
+@cli.command(help="Switch current perimeter")
+@click.option(
+    "-o",
+    "--output",
+    default="",
+    help="Show output in the specified format.",
+    type=click.Choice(["json", ""]),
+)
+@click.option("--id", default="", help="Perimeter name to switch to")
+@click.option(
+    "-f",
+    "--force",
+    is_flag=True,
+    help="Force change the existing perimeter",
+    default=False,
+)
+def switch_perimeter(output="", id=None, force=False):
+    switch_perimeter_response = OuterboundsCommandResponse()
+
+    switch_perimeter_step = CommandStatus(
+        "SwitchPerimeter",
+        OuterboundsCommandStatus.OK,
+        "Perimeter was successfully switched!",
+    )
+
+    if "WORKSTATION_ID" not in os.environ:
+        click.secho(
+            "outerbounds switch-perimeter is only supported on workstations.",
+            fg="red",
+            err=True,
+        )
+        switch_perimeter_step.update(
+            status=OuterboundsCommandStatus.FAIL,
+            reason="outerbounds switch-perimeter is only supported on workstations.",
+            mitigation="",
+        )
+        switch_perimeter_response.add_step(switch_perimeter_step)
+        if output == "json":
+            click.echo(json.dumps(switch_perimeter_response.as_dict(), indent=4))
+        return
+
+    metaflow_home_dir = path.expanduser(
+        os.environ.get("METAFLOW_HOME", "~/.metaflowconfig")
+    )
+
+    if not os.path.exists("{}/config_{}.json".format(metaflow_home_dir, id)):
+        click.secho(
+            "Perimeter {} does not exist or you don't have access to it".format(id),
+            fg="red",
+            err=True,
+        )
+        switch_perimeter_step.update(
+            status=OuterboundsCommandStatus.FAIL,
+            reason="Perimeter {} does not exist or you don't have access to it".format(
+                id
+            ),
+            mitigation="Please contact your admin or the Outerbounds team for assistance.",
+        )
+        switch_perimeter_response.add_step(switch_perimeter_step)
+        if output == "json":
+            click.echo(json.dumps(switch_perimeter_response.as_dict(), indent=4))
+        return
+
+    # If OBP_CONFIG_DIR is set, use that, otherwise use METAFLOW_HOME
+    # If neither are set, use ~/.metaflowconfig
+    obp_config_dir = path.expanduser(
+        os.environ.get(
+            "OBP_CONFIG_DIR", os.environ.get("METAFLOW_HOME", "~/.metaflowconfig")
+        )
+    )
+
+    path_to_config = os.path.expanduser(os.path.join(obp_config_dir, "ob_config.json"))
+
+    if not os.path.exists(path_to_config):
+        click.secho(
+            "Config file not found at {}".format(path_to_config), fg="red", err=True
+        )
+        switch_perimeter_step.update(
+            status=OuterboundsCommandStatus.FAIL,
+            reason="Config file not found",
+            mitigation="Please make sure the config file exists at {}".format(
+                path_to_config
+            ),
+        )
+        switch_perimeter_response.add_step(switch_perimeter_step)
+        if output == "json":
+            click.echo(json.dumps(switch_perimeter_response.as_dict(), indent=4))
+        return
+
+    import fcntl
+
+    fd = os.open(path_to_config, os.O_WRONLY)
+
+    try:
+        if not force:
+            # Try to acquire an exclusive lock
+            fcntl.flock(fd, fcntl.LOCK_EX | fcntl.LOCK_NB)
+        else:
+            click.secho(
+                "Force flag is set. Perimeter will be switched, but can have unintended consequences on other running processes.",
+                fg="yellow",
+            )
+
+        ob_config_dict = {"OB_CURRENT_PERIMETER": id}
+
+        # Now that we have the lock, we can safely write to the file
+        with os.fdopen(fd, "w") as file:
+            json.dump(ob_config_dict, file, indent=4)
+
+        click.secho("Perimeter switched to {}".format(id), fg="green")
+    except BlockingIOError:
+        # This exception is raised if the file is already locked (non-blocking mode)
+        click.secho(
+            "Can't switch perimeter while Metaflow is in use. Please make sure there are no running python processes or notebooks using metaflow.",
+            fg="red",
+            err=True,
+        )
+        switch_perimeter_step.update(
+            status=OuterboundsCommandStatus.FAIL,
+            reason="Can't switch perimeter while Metaflow is in use.",
+            mitigation="Please make sure there are no running python processes or notebooks using metaflow.",
+        )
+
+    switch_perimeter_response.add_step(switch_perimeter_step)
+    if output == "json":
+        click.echo(json.dumps(switch_perimeter_response.as_dict(), indent=4))
+        return
+
+
+@cli.command(help="Show current perimeter")
+@click.option(
+    "-o",
+    "--output",
+    default="",
+    help="Show output in the specified format.",
+    type=click.Choice(["json", ""]),
+)
+def show_current_perimeter(output=""):
+    show_current_perimeter_response = OuterboundsCommandResponse()
+
+    show_current_perimeter_step = CommandStatus(
+        "ShowCurrentPerimeter",
+        OuterboundsCommandStatus.OK,
+        "Current Perimeter Fetch Successful.",
+    )
+
+    if "WORKSTATION_ID" not in os.environ:
+        click.secho(
+            "outerbounds switch-perimeter is only supported on workstations.",
+            fg="red",
+            err=True,
+        )
+        show_current_perimeter_step.update(
+            status=OuterboundsCommandStatus.FAIL,
+            reason="outerbounds show-current-perimeter is only supported on workstations.",
+            mitigation="",
+        )
+        show_current_perimeter_response.add_step(show_current_perimeter_step)
+        if output == "json":
+            click.echo(json.dumps(show_current_perimeter_response.as_dict(), indent=4))
+        return
+
+    metaflow_home_dir = path.expanduser(
+        os.environ.get("METAFLOW_HOME", "~/.metaflowconfig")
+    )
+
+    # If OBP_CONFIG_DIR is set, use that, otherwise use METAFLOW_HOME
+    # If neither are set, use ~/.metaflowconfig
+    obp_config_dir = path.expanduser(
+        os.environ.get(
+            "OBP_CONFIG_DIR", os.environ.get("METAFLOW_HOME", "~/.metaflowconfig")
+        )
+    )
+
+    path_to_config = os.path.expanduser(os.path.join(obp_config_dir, "ob_config.json"))
+
+    if not os.path.exists(path_to_config):
+        click.secho(
+            "Config file not found at {}".format(path_to_config), fg="red", err=True
+        )
+        show_current_perimeter_step.update(
+            status=OuterboundsCommandStatus.FAIL,
+            reason="Config file not found",
+            mitigation="Please make sure the config file exists at {}".format(
+                path_to_config
+            ),
+        )
+        show_current_perimeter_response.add_step(show_current_perimeter_step)
+        if output == "json":
+            click.echo(json.dumps(show_current_perimeter_response.as_dict(), indent=4))
+        return
+
+    with open(path_to_config, "r") as file:
+        ob_config_dict = json.load(file)
+
+    if "OB_CURRENT_PERIMETER" not in ob_config_dict:
+        click.secho(
+            "OB_CURRENT_PERIMETER not found in Config file: {}".format(path_to_config),
+            fg="red",
+            err=True,
+        )
+        show_current_perimeter_step.update(
+            status=OuterboundsCommandStatus.FAIL,
+            reason="OB_CURRENT_PERIMETER not found in Config file: {}",
+            mitigation="",
+        )
+        show_current_perimeter_response.add_step(show_current_perimeter_step)
+        if output == "json":
+            click.echo(json.dumps(show_current_perimeter_response.as_dict(), indent=4))
+        return
+
+    if os.path.exists(
+        os.path.join(
+            metaflow_home_dir,
+            "config_{}.json".format(ob_config_dict["OB_CURRENT_PERIMETER"]),
+        )
+    ):
+        click.secho(
+            "Current Perimeter: {}".format(ob_config_dict["OB_CURRENT_PERIMETER"]),
+            fg="green",
+        )
+        show_current_perimeter_response.add_or_update_data(
+            "current_perimeter", ob_config_dict["OB_CURRENT_PERIMETER"]
+        )
+    else:
+        click.secho(
+            "Perimeter config file not found at {}".format(
+                os.path.join(
+                    metaflow_home_dir,
+                    "config_{}.json".format(ob_config_dict["OB_CURRENT_PERIMETER"]),
+                )
+            ),
+            fg="red",
+            err=True,
+        )
+        show_current_perimeter_step.update(
+            status=OuterboundsCommandStatus.FAIL,
+            reason="Perimeter config file not found",
+            mitigation="Please make sure the perimeter config file exists at {}/config_{}.json".format(
+                metaflow_home_dir, ob_config_dict["OB_CURRENT_PERIMETER"]
+            ),
+        )
+        show_current_perimeter_response.add_step(show_current_perimeter_step)
+
+    if output == "json":
+        click.echo(json.dumps(show_current_perimeter_response.as_dict(), indent=4))
+
+
+@cli.command(help="List all available perimeters")
+@click.option(
+    "-o",
+    "--output",
+    default="",
+    help="Show output in the specified format.",
+    type=click.Choice(["json", ""]),
+)
+def list_perimeters(output=""):
+    list_perimeters_response = OuterboundsCommandResponse()
+
+    list_perimeters_step = CommandStatus(
+        "ListPerimeters", OuterboundsCommandStatus.OK, "Perimeter Fetch Successful."
+    )
+
+    if "WORKSTATION_ID" not in os.environ:
+        click.secho(
+            "outerbounds list-perimeters is only supported on workstations.",
+            fg="red",
+            err=True,
+        )
+        list_perimeters_step.update(
+            status=OuterboundsCommandStatus.FAIL,
+            reason="outerbounds list-perimeters is only supported on workstations.",
+            mitigation="",
+        )
+        list_perimeters_response.add_step(list_perimeters_step)
+        if output == "json":
+            click.echo(json.dumps(list_perimeters_response.as_dict(), indent=4))
+        return
+
+    metaflow_home_dir = path.expanduser(
+        os.environ.get("METAFLOW_HOME", "~/.metaflowconfig")
+    )
+
+    # If OBP_CONFIG_DIR is set, use that, otherwise use METAFLOW_HOME
+    # If neither are set, use ~/.metaflowconfig
+    obp_config_dir = path.expanduser(
+        os.environ.get(
+            "OBP_CONFIG_DIR", os.environ.get("METAFLOW_HOME", "~/.metaflowconfig")
+        )
+    )
+
+    path_to_config = os.path.expanduser(os.path.join(obp_config_dir, "ob_config.json"))
+
+    if not os.path.exists(path_to_config):
+        click.secho(
+            "Config file not found at {}".format(path_to_config), fg="red", err=True
+        )
+        list_perimeters_step.update(
+            status=OuterboundsCommandStatus.FAIL,
+            reason="Config file not found",
+            mitigation="Please make sure the config file exists at {}".format(
+                path_to_config
+            ),
+        )
+        list_perimeters_response.add_step(list_perimeters_step)
+        if output == "json":
+            click.echo(json.dumps(list_perimeters_response.as_dict(), indent=4))
+        return
+
+    with open(path_to_config, "r") as file:
+        ob_config_dict = json.load(file)
+
+    if "OB_CURRENT_PERIMETER" not in ob_config_dict:
+        click.secho(
+            "OB_CURRENT_PERIMETER not found in Config file: {}".format(path_to_config),
+            fg="red",
+            err=True,
+        )
+        list_perimeters_step.update(
+            status=OuterboundsCommandStatus.FAIL,
+            reason="OB_CURRENT_PERIMETER not found in Config file: {}",
+            mitigation="",
+        )
+        list_perimeters_response.add_step(list_perimeters_step)
+        if output == "json":
+            click.echo(json.dumps(list_perimeters_response.as_dict(), indent=4))
+        return
+
+    if os.path.exists(
+        os.path.join(
+            metaflow_home_dir,
+            "config_{}.json".format(ob_config_dict["OB_CURRENT_PERIMETER"]),
+        )
+    ):
+        active_perimeter = ob_config_dict["OB_CURRENT_PERIMETER"]
+    else:
+        click.secho(
+            "Perimeter config file not found at {}".format(
+                os.path.join(
+                    metaflow_home_dir,
+                    "config_{}.json".format(ob_config_dict["OB_CURRENT_PERIMETER"]),
+                )
+            ),
+            fg="red",
+            err=True,
+        )
+        list_perimeters_step.update(
+            status=OuterboundsCommandStatus.FAIL,
+            reason="Perimeter config file not found",
+            mitigation="Please make sure the perimeter config file exists at {}/config_{}.json".format(
+                metaflow_home_dir, ob_config_dict["OB_CURRENT_PERIMETER"]
+            ),
+        )
+        list_perimeters_response.add_step(list_perimeters_step)
+        return
+
+    perimeter_list = []
+    for file in os.listdir(metaflow_home_dir):
+        if file.startswith("config_") and file.endswith(".json"):
+            perimeter_id = file.split("_")[1].split(".")[0]
+            perimeter_list.append(
+                {"id": perimeter_id, "active": perimeter_id == active_perimeter}
+            )
+
+    list_perimeters_response.add_or_update_data("perimeters", perimeter_list)
+    if output == "json":
+        click.echo(json.dumps(list_perimeters_response.as_dict(), indent=4))

outerbounds/utils/schema.py

@@ -37,10 +37,14 @@ class OuterboundsCommandResponse:
         self._message = ""
         self._steps = []
         self.metadata = {}
+        self._data = {}
 
     def add_or_update_metadata(self, key, value):
         self.metadata[key] = value
 
+    def add_or_update_data(self, key, value):
+        self._data[key] = value
+
     def add_step(self, step: CommandStatus):
         self._steps.append(step)
         self._process_step_status(step)
@@ -65,4 +69,5 @@ class OuterboundsCommandResponse:
             "message": self._message,
             "steps": [step.as_dict() for step in self._steps],
             "metadata": self.metadata,
+            "data": self._data,
         }

{outerbounds-0.3.51.dist-info → outerbounds-0.3.52rc0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: outerbounds
-Version: 0.3.51
+Version: 0.3.52rc0
 Summary: More Data Science, Less Administration
 License: Proprietary
 Keywords: data science,machine learning,MLOps
@@ -14,17 +14,13 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Provides-Extra: azure
-Provides-Extra: gcp
 Requires-Dist: PyYAML (>=6.0,<7.0)
 Requires-Dist: azure-identity (>=1.15.0,<2.0.0) ; extra == "azure"
 Requires-Dist: azure-storage-blob (>=12.9.0,<13.0.0) ; extra == "azure"
 Requires-Dist: boto3
 Requires-Dist: click (>=8.1.3,<9.0.0)
-Requires-Dist: google-api-core (>=2.16.1,<3.0.0) ; extra == "gcp"
-Requires-Dist: google-auth (>=2.27.0,<3.0.0) ; extra == "gcp"
-Requires-Dist: google-cloud-storage (>=2.14.0,<3.0.0) ; extra == "gcp"
-Requires-Dist: ob-metaflow (==2.11.0.4)
-Requires-Dist: ob-metaflow-extensions (==1.1.42)
+Requires-Dist: ob-metaflow (==2.11.0.3)
+Requires-Dist: ob-metaflow-extensions (==1.1.42rc0)
 Requires-Dist: opentelemetry-distro (==0.41b0)
 Requires-Dist: opentelemetry-exporter-otlp-proto-http (==1.20.0)
 Requires-Dist: opentelemetry-instrumentation-requests (==0.41b0)

{outerbounds-0.3.51.dist-info → outerbounds-0.3.52rc0.dist-info}/RECORD

@@ -2,13 +2,13 @@ outerbounds/__init__.py,sha256=GPdaubvAYF8pOFWJ3b-sPMKCpyfpteWVMZWkmaYhxRw,32
 outerbounds/cli_main.py,sha256=e9UMnPysmc7gbrimq2I4KfltggyU7pw59Cn9aEguVcU,74
 outerbounds/command_groups/__init__.py,sha256=QPWtj5wDRTINDxVUL7XPqG3HoxHNvYOg08EnuSZB2Hc,21
 outerbounds/command_groups/cli.py,sha256=61VsBlPG2ykP_786eCyllqeM8DMhPAOfj2FhktrSd7k,207
-outerbounds/command_groups/local_setup_cli.py,sha256=5S1bcq8mW5YS-PZBO4ZrBAeLwFqcQYmm_t9ALjT77nU,28312
+outerbounds/command_groups/local_setup_cli.py,sha256=HOTvOlb22cF86QmDpdQc6UVx4gFa2hBzsM8qI7Yj6vY,41486
 outerbounds/command_groups/workstations_cli.py,sha256=VgydQzCas3mlAFyzZuanjl1E8Zh7pBrbKbbP6t6N2WU,18237
 outerbounds/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 outerbounds/utils/kubeconfig.py,sha256=l1mUP1j9VIq3fsffi5bJ1Nk-hYlwd1dIqkpj7DvVS1E,7936
 outerbounds/utils/metaflowconfig.py,sha256=zdSeZEc1h4yJAZUrfWIO9EYSy84wdE_JCSEiCxb-su8,2341
-outerbounds/utils/schema.py,sha256=nBuarFbdZu0LGhG0YkJ6pEIvdglfM_TO_W_Db2vksb0,2017
-outerbounds-0.3.51.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
-outerbounds-0.3.51.dist-info/entry_points.txt,sha256=7ye0281PKlvqxu15rjw60zKg2pMsXI49_A8BmGqIqBw,47
-outerbounds-0.3.51.dist-info/METADATA,sha256=WAr8ATcx7tGjEu5BMi8yGFU5Er2BiYSqwgFo4X-7yVc,1361
-outerbounds-0.3.51.dist-info/RECORD,,
+outerbounds/utils/schema.py,sha256=4_ONlvZGpBb51KKd-q6mNSKWI9P1huOKafrsf9kVqp8,2152
+outerbounds-0.3.52rc0.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
+outerbounds-0.3.52rc0.dist-info/entry_points.txt,sha256=7ye0281PKlvqxu15rjw60zKg2pMsXI49_A8BmGqIqBw,47
+outerbounds-0.3.52rc0.dist-info/METADATA,sha256=xkqrbbaDvrjERYy5fZ0kqk8Y_TEGneAjF5H0e6-uiNs,1148
+outerbounds-0.3.52rc0.dist-info/RECORD,,