outerbounds 0.3.175rc0__py3-none-any.whl → 0.3.175rc1__py3-none-any.whl

outerbounds/apps/app_cli.py

@@ -231,6 +231,18 @@ def common_deploy_options(func):
         help="Maximum number of replicas to deploy",
         default=None,
     )
+    @click.option(
+        "--description",
+        type=str,
+        help="The description of the app to deploy.",
+        default=None,
+    )
+    @click.option(
+        "--app-type",
+        type=str,
+        help="The type of app to deploy.",
+        default=None,
+    )
     @wraps(func)
     def wrapper(*args, **kwargs):
         return func(*args, **kwargs)

outerbounds/apps/capsule.py

@@ -172,10 +172,16 @@ class CapsuleInput:
             _scheduling_config["computePools"] = [
                 {"name": x} for x in app_config.get_state("compute_pools")
             ]
-
+        _description = app_config.get_state("description")
+        _app_type = app_config.get_state("app_type")
+        _final_info = {}
+        if _description:
+            _final_info["description"] = _description
+        if _app_type:
+            _final_info["endpointType"] = _app_type
         return {
             "perimeter": app_config.get_state("perimeter"),
-            # "environmentPath": "environments/python3.9",
+            **_final_info,
             "codePackagePath": app_config.get_state("code_package_url"),
             "image": app_config.get_state("image"),
             "resourceIntegrations": [

outerbounds/apps/cli_to_config.py

@@ -6,7 +6,7 @@ def build_config_from_options(options):
     config = {}
 
     # Set basic fields
-    for key in ["name", "port", "image", "compute_pools"]:
+    for key in ["name", "port", "image", "compute_pools", "description", "app_type"]:
         if options.get(key):
             config[key] = options[key]
 

outerbounds/apps/config_schema.yaml

@@ -33,11 +33,20 @@ properties:
     example:
       - foo: bar
       - x: y
+  description: # Only used in `deploy` command
+    allow_union: true
+    type: string
+    description: The description of the app to deploy.
+    example: "This is a description of my app."
+  app_type: # Only used in `deploy` command
+    allow_union: true
+    type: string
+    description: The User defined type of app to deploy. Its only used for bookkeeping purposes.
+    example: "MyCustomAgent"
   image: # Only used in `deploy` command
     allow_union: true # We will overrwite the image if specified on the CLI.
     type: string
     description: The Docker image to deploy with the App.
-    example: "python:3.10-slim"
   secrets: # Used in `run` command
     allow_union: true
     type: array

outerbounds/command_groups/cli.py

@@ -7,6 +7,7 @@ from . import (
     tutorials_cli,
     fast_bakery_cli,
     secrets_cli,
+    flowprojects_cli,
 )
 
 
@@ -20,6 +21,7 @@ from . import (
         tutorials_cli.cli,
         fast_bakery_cli.cli,
         secrets_cli.cli,
+        flowprojects_cli.cli,
     ],
 )
 def cli(**kwargs):

outerbounds/command_groups/flowprojects_cli.py

@@ -0,0 +1,137 @@
+import json
+import os
+import sys
+import requests
+
+from ..utils import metaflowconfig
+from outerbounds._vendor import click
+
+
+@click.group()
+def cli(**kwargs):
+    pass
+
+
+@cli.group(help="Commands for pushing Deployments metadata.", hidden=True)
+def flowproject(**kwargs):
+    pass
+
+
+@flowproject.command()
+@click.option(
+    "-d",
+    "--config-dir",
+    default=os.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("--id", help="The ID for this deployment")
+def get_metadata(config_dir, profile, id):
+    api_url = metaflowconfig.get_sanitized_url_from_config(
+        config_dir, profile, "OBP_API_SERVER"
+    )
+    perimeter = _get_perimeter()
+    headers = _get_request_headers()
+
+    project, branch = _parse_id(id)
+
+    # GET the latest flowproject config in order to modify it
+    # /v1/perimeters/:perimeter/:project/:branch/flowprojects/latest
+    response = requests.get(
+        url=f"{api_url}/v1/perimeters/{perimeter}/projects/{project}/branches/{branch}/latestflowproject",
+        headers=headers,
+    )
+    if response.status_code >= 500:
+        raise Exception("API request failed.")
+
+    body = response.json()
+    if response.status_code >= 400:
+        raise Exception("request failed: %s" % body)
+
+    out = json.dumps(body)
+
+    print(out, file=sys.stdout)
+
+
+@flowproject.command()
+@click.option(
+    "-d",
+    "--config-dir",
+    default=os.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.argument("json_str")
+def set_metadata(config_dir, profile, json_str):
+    api_url = metaflowconfig.get_sanitized_url_from_config(
+        config_dir, profile, "OBP_API_SERVER"
+    )
+
+    perimeter = _get_perimeter()
+    headers = _get_request_headers()
+    payload = json.loads(json_str)
+
+    # POST the updated flowproject config
+    # /v1/perimeters/:perimeter/flowprojects
+    response = requests.post(
+        url=f"{api_url}/v1/perimeters/{perimeter}/flowprojects",
+        json=payload,
+        headers=headers,
+    )
+    if response.status_code >= 500:
+        raise Exception("API request failed. %s" % response.text)
+
+    if response.status_code >= 400:
+        raise Exception("request failed: %s" % response.text)
+    body = response.json()
+
+    print(body, file=sys.stdout)
+
+
+def _get_request_headers():
+    headers = {"Content-Type": "application/json", "Connection": "keep-alive"}
+    try:
+        from metaflow.metaflow_config import SERVICE_HEADERS
+
+        headers = {**headers, **(SERVICE_HEADERS or {})}
+    except ImportError:
+        headers = headers
+
+    return headers
+
+
+def _get_perimeter():
+    # Get current perimeter
+    from metaflow_extensions.outerbounds.remote_config import init_config  # type: ignore
+
+    conf = init_config()
+    if "OBP_PERIMETER" in conf:
+        perimeter = conf["OBP_PERIMETER"]
+    else:
+        # if the perimeter is not in metaflow config, try to get it from the environment
+        perimeter = os.environ.get("OBP_PERIMETER", None)
+    if perimeter is None:
+        raise Exception("Perimeter not found in config, but is required.")
+
+    return perimeter
+
+
+def _parse_id(id: str):
+    parts = id.split("/")
+    if len(parts) != 2:
+        raise Exception("ID should consist of two parts: project/branch")
+
+    project, branch = parts
+    return project, branch

{outerbounds-0.3.175rc0.dist-info → outerbounds-0.3.175rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: outerbounds
-Version: 0.3.175rc0
+Version: 0.3.175rc1
 Summary: More Data Science, Less Administration
 License: Proprietary
 Keywords: data science,machine learning,MLOps
@@ -29,8 +29,8 @@ Requires-Dist: google-cloud-secret-manager (>=2.20.0,<3.0.0) ; extra == "gcp"
 Requires-Dist: google-cloud-storage (>=2.14.0,<3.0.0) ; extra == "gcp"
 Requires-Dist: metaflow-checkpoint (==0.2.1)
 Requires-Dist: ob-metaflow (==2.15.14.1)
-Requires-Dist: ob-metaflow-extensions (==1.1.162rc0)
-Requires-Dist: ob-metaflow-stubs (==6.0.3.175rc0)
+Requires-Dist: ob-metaflow-extensions (==1.1.161rc1)
+Requires-Dist: ob-metaflow-stubs (==6.0.3.175rc1)
 Requires-Dist: opentelemetry-distro (>=0.41b0) ; extra == "otel"
 Requires-Dist: opentelemetry-exporter-otlp-proto-http (>=1.20.0) ; extra == "otel"
 Requires-Dist: opentelemetry-instrumentation-requests (>=0.41b0) ; extra == "otel"

{outerbounds-0.3.175rc0.dist-info → outerbounds-0.3.175rc1.dist-info}/RECORD

@@ -40,15 +40,15 @@ outerbounds/_vendor/yaml/scanner.py,sha256=ZcI8IngR56PaQ0m27WU2vxCqmDCuRjz-hr7pi
 outerbounds/_vendor/yaml/serializer.py,sha256=8wFZRy9SsQSktF_f9OOroroqsh4qVUe53ry07P9UgCc,4368
 outerbounds/_vendor/yaml/tokens.py,sha256=JBSu38wihGr4l73JwbfMA7Ks1-X84g8-NskTz7KwPmA,2578
 outerbounds/apps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-outerbounds/apps/app_cli.py,sha256=oUsPGDr3jnW5l7h4Mp1I4WnRZAanXN1se9_aQ1ybhNQ,17559
+outerbounds/apps/app_cli.py,sha256=zJFjoO6wPjRoKOPywWZ7NqXt4HwlHfPMQ6AquvKKAus,17833
 outerbounds/apps/app_config.py,sha256=KBmW9grhiuG9XZG-R0GZkM-024cjj6ztGzOX_2wZW34,11291
 outerbounds/apps/artifacts.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-outerbounds/apps/capsule.py,sha256=n23uJi9877IVnArgqdq_ES_c2vAql8rzVm7jlTYUr1M,13351
-outerbounds/apps/cli_to_config.py,sha256=IjPHeH1lC7l9WPkNLQIWU7obRS3G0G8aTNVZemUvmuw,3168
+outerbounds/apps/capsule.py,sha256=BRUBF8WV_lm4QCnxxPQ6jlikdKS_bvf41pwrRqgWIpQ,13608
+outerbounds/apps/cli_to_config.py,sha256=hV6rfPgCiAX03O363GkvdjSIJBt3-oSbL6F2sTUucFE,3195
 outerbounds/apps/code_package/__init__.py,sha256=8McF7pgx8ghvjRnazp2Qktlxi9yYwNiwESSQrk-2oW8,68
 outerbounds/apps/code_package/code_packager.py,sha256=SQDBXKwizzpag5GpwoZpvvkyPOodRSQwk2ecAAfO0HI,23316
 outerbounds/apps/code_package/examples.py,sha256=aF8qKIJxCVv_ugcShQjqUsXKKKMsm1oMkQIl8w3QKuw,4016
-outerbounds/apps/config_schema.yaml,sha256=D-qopf3mGZusa4n5GIbrssoJHS3v96_yponFEM127b4,8275
+outerbounds/apps/config_schema.yaml,sha256=bN7mXlVddqN8G4jq6qBpVXl_qFJdOYrmj8E4OY23Rr8,8641
 outerbounds/apps/dependencies.py,sha256=SqvdFQdFZZW0wXX_CHMHCrfE0TwaRkTvGCRbQ2Mx3q0,3935
 outerbounds/apps/deployer.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 outerbounds/apps/experimental/__init__.py,sha256=12L_FzZyzv162uo4I6cmlrxat7feUtIu_kxbObTJZTA,3059
@@ -58,8 +58,9 @@ outerbounds/apps/validations.py,sha256=AVEw9eCvkzqq1m5ZC8btaWrSR6kWYKzarELfrASuA
 outerbounds/cli_main.py,sha256=e9UMnPysmc7gbrimq2I4KfltggyU7pw59Cn9aEguVcU,74
 outerbounds/command_groups/__init__.py,sha256=QPWtj5wDRTINDxVUL7XPqG3HoxHNvYOg08EnuSZB2Hc,21
 outerbounds/command_groups/apps_cli.py,sha256=weXYgUbTVIxMSweLVdod_C1laiB32YKwYhf22OfqQJE,20815
-outerbounds/command_groups/cli.py,sha256=de4_QY1UeoKX6y-IXIbmklAi6bz0DsdBSmAoCg6lq1o,482
+outerbounds/command_groups/cli.py,sha256=I8b0zyY_xhZfmaLgJcgR98YXxgirkUK7xsjknEd4nfc,534
 outerbounds/command_groups/fast_bakery_cli.py,sha256=5kja7v6C651XAY6dsP_IkBPJQgfU4hA4S9yTOiVPhW0,6213
+outerbounds/command_groups/flowprojects_cli.py,sha256=gFAA_zUIyhD092Hd7IW5InuIxOqdwRJsHgyWQjy8LZw,3792
 outerbounds/command_groups/local_setup_cli.py,sha256=tuuqJRXQ_guEwOuQSIf9wkUU0yg8yAs31myGViAK15s,36364
 outerbounds/command_groups/perimeters_cli.py,sha256=iF_Uw7ROiSctf6FgoJEy30iDBLVE1j9FKuR3shgJRmc,19050
 outerbounds/command_groups/secrets_cli.py,sha256=Vgn_aiTo76a0s5hCJhNWEOrCVhyYeivD08ooQxz0y7c,2952
@@ -71,7 +72,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.175rc0.dist-info/METADATA,sha256=c69bE_dY1O_vbcTLpQ0FWj2xL0rF1sIvuI-e3A8MTXA,1846
-outerbounds-0.3.175rc0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-outerbounds-0.3.175rc0.dist-info/entry_points.txt,sha256=7ye0281PKlvqxu15rjw60zKg2pMsXI49_A8BmGqIqBw,47
-outerbounds-0.3.175rc0.dist-info/RECORD,,
+outerbounds-0.3.175rc1.dist-info/METADATA,sha256=BzZlrHhvLf-__NA2SX6gihlFIgGuXyJ-VhzpVrjSi3Q,1846
+outerbounds-0.3.175rc1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+outerbounds-0.3.175rc1.dist-info/entry_points.txt,sha256=7ye0281PKlvqxu15rjw60zKg2pMsXI49_A8BmGqIqBw,47
+outerbounds-0.3.175rc1.dist-info/RECORD,,