together 2.0.0a15__py3-none-any.whl → 2.0.0a17__py3-none-any.whl

together/lib/cli/api/beta/{clusters.py → clusters/create.py}

@@ -2,64 +2,17 @@ from __future__ import annotations
 
 import json as json_lib
 import getpass
-from typing import Any, Dict, List, Literal
+from typing import List, Literal
 
 import click
 from rich import print
-from tabulate import tabulate
 
-from together import Together, omit
-from together._response import APIResponse as APIResponse
-from together.types.beta import Cluster, ClusterCreateParams
-from together.lib.cli.api.utils import handle_api_errors
-from together.types.beta.cluster_create_params import SharedVolume
-from together.lib.cli.api.beta.clusters_storage import storage
+from together import Together
+from together.lib.cli.api._utils import handle_api_errors
+from together.types.beta.cluster_create_params import SharedVolume, ClusterCreateParams
 
 
-def print_clusters(clusters: List[Cluster]) -> None:
-    data: List[Dict[str, Any]] = []
-    for cluster in clusters:
-        data.append(
-            {
-                "ID": cluster.cluster_id,
-                "Name": cluster.cluster_name,
-                "Status": cluster.status,
-                "Region": cluster.region,
-            }
-        )
-    click.echo(tabulate(data, headers="keys", tablefmt="grid"))
-
-
-@click.group()
-@click.pass_context
-def clusters(ctx: click.Context) -> None:
-    """Clusters API commands"""
-    pass
-
-
-clusters.add_command(storage)
-
-
-@clusters.command()
-@click.option(
-    "--json",
-    is_flag=True,
-    help="Output in JSON format",
-)
-@click.pass_context
-def list(ctx: click.Context, json: bool) -> None:
-    """List clusters"""
-    client: Together = ctx.obj
-
-    response = client.beta.clusters.list()
-
-    if json:
-        click.echo(json_lib.dumps(response.model_dump(exclude_none=True), indent=4))
-    else:
-        print_clusters(response.clusters)
-
-
-@clusters.command()
+@click.command()
 @click.option(
     "--name",
     type=str,
@@ -228,130 +181,3 @@ def create(
     else:
         click.echo(f"Clusters: Cluster created successfully")
         click.echo(f"Clusters: {response.cluster_id}")
-
-
-@clusters.command()
-@click.argument("cluster-id", required=True)
-@click.option(
-    "--json",
-    is_flag=True,
-    help="Output in JSON format",
-)
-@click.pass_context
-@handle_api_errors("Clusters")
-def retrieve(ctx: click.Context, cluster_id: str, json: bool) -> None:
-    """Retrieve a cluster by ID"""
-    client: Together = ctx.obj
-
-    if not json:
-        click.echo(f"Clusters: Retrieving cluster...")
-
-    response = client.beta.clusters.retrieve(cluster_id)
-
-    if json:
-        click.echo(json_lib.dumps(response.model_dump(exclude_none=True), indent=4))
-    else:
-        print(response)
-
-
-@clusters.command()
-@click.argument("cluster-id", required=True)
-@click.option(
-    "--num-gpus",
-    type=int,
-    help="Number of GPUs to allocate in the cluster",
-)
-@click.option(
-    "--cluster-type",
-    type=click.Choice(["KUBERNETES", "SLURM"]),
-    help="Cluster type",
-)
-@click.option(
-    "--json",
-    is_flag=True,
-    help="Output in JSON format",
-)
-@click.pass_context
-@handle_api_errors("Clusters")
-def update(
-    ctx: click.Context,
-    cluster_id: str,
-    num_gpus: int | None = None,
-    cluster_type: Literal["KUBERNETES", "SLURM"] | None = None,
-    json: bool = False,
-) -> None:
-    """Update a cluster"""
-    client: Together = ctx.obj
-
-    if not json:
-        click.echo("Clusters: Updating cluster...")
-
-    client.beta.clusters.update(
-        cluster_id,
-        num_gpus=num_gpus if num_gpus is not None else omit,
-        cluster_type=cluster_type if cluster_type is not None else omit,
-    )
-
-    if json:
-        cluster = client.beta.clusters.retrieve(cluster_id)
-        click.echo(json_lib.dumps(cluster.model_dump(exclude_none=True), indent=4))
-    else:
-        click.echo("Clusters: Done")
-
-
-@clusters.command()
-@click.argument("cluster-id", required=True)
-@click.option(
-    "--json",
-    is_flag=True,
-    help="Output in JSON format",
-)
-@click.pass_context
-@handle_api_errors("Clusters")
-def delete(ctx: click.Context, cluster_id: str, json: bool) -> None:
-    """Delete a cluster by ID"""
-    client: Together = ctx.obj
-
-    if json:
-        response = client.beta.clusters.delete(cluster_id=cluster_id)
-        click.echo(json_lib.dumps(response.model_dump(), indent=2))
-        return
-
-    cluster = client.beta.clusters.retrieve(cluster_id=cluster_id)
-    print_clusters([cluster])
-    if not click.confirm(f"Clusters: Are you sure you want to delete cluster {cluster.cluster_name}?"):
-        return
-
-    click.echo("Clusters: Deleting cluster...")
-    response = client.beta.clusters.delete(cluster_id=cluster_id)
-
-    click.echo(f"Clusters: Deleted cluster {cluster.cluster_name}")
-
-
-@clusters.command()
-@click.option(
-    "--json",
-    is_flag=True,
-    help="Output in JSON format",
-)
-@click.pass_context
-@handle_api_errors("Clusters")
-def list_regions(ctx: click.Context, json: bool) -> None:
-    """List regions"""
-    client: Together = ctx.obj
-
-    response = client.beta.clusters.list_regions()
-
-    if json:
-        click.echo(json_lib.dumps(response.model_dump(exclude_none=True), indent=4))
-    else:
-        data: List[Dict[str, Any]] = []
-        for region in response.regions:
-            data.append(
-                {
-                    "Name": region.name,
-                    "Availability Zones": ", ".join(region.availability_zones) if region.availability_zones else "",
-                    "Driver Versions": ", ".join(region.driver_versions) if region.driver_versions else "",
-                }
-            )
-        click.echo(tabulate(data, headers="keys", tablefmt="grid"))

together/lib/cli/api/beta/clusters/delete.py

@@ -0,0 +1,35 @@
+import json as json_lib
+
+import click
+
+from together import Together
+from together.lib.cli.api._utils import handle_api_errors
+
+
+@click.command()
+@click.argument("cluster-id", required=True)
+@click.option(
+    "--json",
+    is_flag=True,
+    help="Output in JSON format",
+)
+@click.pass_context
+@handle_api_errors("Clusters")
+def delete(ctx: click.Context, cluster_id: str, json: bool) -> None:
+    """Delete a cluster by ID"""
+    client: Together = ctx.obj
+
+    if json:
+        response = client.beta.clusters.delete(cluster_id=cluster_id)
+        click.echo(json_lib.dumps(response.model_dump(), indent=2))
+        return
+
+    cluster = client.beta.clusters.retrieve(cluster_id=cluster_id)
+    ctx.obj.print_clusters([cluster])
+    if not click.confirm(f"Clusters: Are you sure you want to delete cluster {cluster.cluster_name}?"):
+        return
+
+    click.echo("Clusters: Deleting cluster...")
+    response = client.beta.clusters.delete(cluster_id=cluster_id)
+
+    click.echo(f"Clusters: Deleted cluster {cluster.cluster_name}")

together/lib/cli/api/beta/clusters/get_credentials.py

@@ -0,0 +1,151 @@
+from __future__ import annotations
+
+import os
+import stat
+import errno
+import platform
+from typing import Any
+from pathlib import Path
+
+import click
+
+from together import Together, TogetherError
+from together.lib.cli.api._utils import handle_api_errors
+
+
+@click.command()
+@click.argument("cluster-id", required=True)
+@click.option(
+    "--file",
+    default=os.path.join(os.path.expanduser("~"), ".kube", "config"),
+    show_default=True,
+    type=str,
+    help="Path to write the kubeconfig to. If you pass `-` it will print the config to stdout instead of writing to a file.",
+)
+@click.option(
+    "--context-name",
+    type=str,
+    help="Name of the context to add to the kubeconfig. By default it will be the cluster name.",
+)
+@click.option(
+    "--overwrite-existing",
+    is_flag=True,
+    help="If there is a conflict with the existing kubeconfig, overwrite the existing kubeconfig instead of raising an error.",
+)
+@click.option(
+    "--set-default-context",
+    is_flag=True,
+    help="Change the current context for kubectl to the new context.",
+)
+@click.pass_context
+@handle_api_errors("Clusters")
+def get_credentials(
+    ctx: click.Context,
+    cluster_id: str,
+    file: str,
+    context_name: str | None = None,
+    overwrite_existing: bool = False,
+    set_default_context: bool = False,
+) -> None:
+    """Get cluster credentials"""
+    client: Together = ctx.obj
+
+    cluster = client.beta.clusters.retrieve(cluster_id)
+
+    import base64
+
+    kube_config = base64.b64decode(cluster.kube_config).decode("utf-8")
+
+    if len(kube_config) == 0:
+        click.echo("No kubeconfig found for cluster at this time.")
+        return
+
+    if file == "-":
+        click.echo(kube_config)
+        return
+
+    kube_config_path = Path(os.path.expanduser(file if file else "~/.kube/config"))
+
+    # ensure that at least an empty ~/.kube/config exists
+    directory = os.path.dirname(kube_config_path)
+    if directory and not os.path.exists(directory):
+        try:
+            os.makedirs(directory)
+        except OSError as ex:
+            if ex.errno != errno.EEXIST:
+                raise
+    if not os.path.exists(kube_config_path):
+        with os.fdopen(os.open(kube_config_path, os.O_CREAT | os.O_WRONLY, 0o600), "wt"):
+            pass
+
+    # Write the decoded kubeconfig to the user's default kubeconfig path
+    # Ensure the .kube directory exists before writing the config file
+    try:
+        from yaml import dump, safe_load
+    except ImportError:
+        click.secho("Together cli dependencies are missing. Please run one of the following commands:\n", fg="red")
+        click.secho("uv:  uv add together --optional cli", fg="yellow")
+        click.secho("pip: pip install together[cli]", fg="yellow")
+        return
+
+    # Load both configs into dictionaries to merge them
+    kube_config_dict: dict[str, Any] | None = safe_load(kube_config_path.read_text())
+    incoming_config_dict: dict[str, Any] = safe_load(kube_config)
+
+    # If the user did not pass a custom context name, we will use the cluster name
+    if context_name is None:
+        context_name = cluster.cluster_name
+
+    # Update the context name on the incoming data.
+    incoming_config_dict["contexts"][0]["name"] = context_name
+    incoming_config_dict["contexts"][0]["context"]["cluster"] = context_name
+    incoming_config_dict["clusters"][0]["name"] = context_name
+
+    # If there is not a current kube config on disk, we can safely just take the incoming config
+    if kube_config_dict is None:
+        kube_config_dict = incoming_config_dict
+    else:
+        _handle_merge(kube_config_dict, incoming_config_dict, "clusters", overwrite_existing)
+        _handle_merge(kube_config_dict, incoming_config_dict, "users", overwrite_existing)
+        _handle_merge(kube_config_dict, incoming_config_dict, "contexts", overwrite_existing)
+
+    # Set the current context to the new context if the user requested it.
+    if set_default_context:
+        kube_config_dict["current-context"] = context_name
+
+    # check that ~/.kube/config is only read- and writable by its owner
+    if platform.system() != "Windows" and not os.path.islink(kube_config_path):
+        existing_file_perms = "{:o}".format(stat.S_IMODE(os.lstat(kube_config_path).st_mode))
+        if not existing_file_perms.endswith("600"):
+            click.echo(
+                f'{kube_config_path} has permissions "{existing_file_perms}".\nIt should be readable and writable only by its owner.',
+            )
+            return
+
+    with open(kube_config_path, "w+") as stream:
+        stream.write(dump(kube_config_dict))
+
+    click.secho(f"Kubeconfig written to {kube_config_path}", fg="green")
+
+
+def _handle_merge(existing: dict[str, Any], addition: dict[str, Any], key: str, overwrite_existing: bool) -> None:
+    """Merge the incoming kube config into the existing config for the given key."""
+    if not addition.get(key, False):
+        return
+    if not existing.get(key):
+        existing[key] = addition[key]
+        return
+
+    for i in addition[key]:
+        for j in existing[key]:
+            if not i.get("name", False) or not j.get("name", False):
+                continue
+            if i["name"] == j["name"]:
+                if overwrite_existing or i == j:
+                    existing[key].remove(j)
+                    break
+                else:
+                    raise TogetherError(
+                        f"A different object named {i['name']} already exists in {key} in your kubeconfig file."
+                    )
+        existing[key].append(i)

together/lib/cli/api/beta/clusters/list.py

@@ -0,0 +1,24 @@
+import json as json_lib
+
+import click
+
+from together import Together
+
+
+@click.command()
+@click.option(
+    "--json",
+    is_flag=True,
+    help="Output in JSON format",
+)
+@click.pass_context
+def list(ctx: click.Context, json: bool) -> None:
+    """List clusters"""
+    client: Together = ctx.obj
+
+    response = client.beta.clusters.list()
+
+    if json:
+        click.echo(json_lib.dumps(response.model_dump(exclude_none=True), indent=4))
+    else:
+        ctx.obj.print_clusters(response.clusters)

together/lib/cli/api/beta/clusters/list_regions.py

@@ -0,0 +1,37 @@
+import json as json_lib
+from typing import Any, Dict, List
+
+import click
+from tabulate import tabulate
+
+from together import Together
+from together.lib.cli.api._utils import handle_api_errors
+
+
+@click.command()
+@click.option(
+    "--json",
+    is_flag=True,
+    help="Output in JSON format",
+)
+@click.pass_context
+@handle_api_errors("Clusters")
+def list_regions(ctx: click.Context, json: bool) -> None:
+    """List regions"""
+    client: Together = ctx.obj
+
+    response = client.beta.clusters.list_regions()
+
+    if json:
+        click.echo(json_lib.dumps(response.model_dump(exclude_none=True), indent=4))
+    else:
+        data: List[Dict[str, Any]] = []
+        for region in response.regions:
+            data.append(
+                {
+                    "Name": region.name,
+                    "Availability Zones": ", ".join(region.availability_zones) if region.availability_zones else "",
+                    "Driver Versions": ", ".join(region.driver_versions) if region.driver_versions else "",
+                }
+            )
+        click.echo(tabulate(data, headers="keys", tablefmt="grid"))

together/lib/cli/api/beta/clusters/retrieve.py

@@ -0,0 +1,31 @@
+import json as json_lib
+
+import click
+from rich import print
+
+from together import Together
+from together.lib.cli.api._utils import handle_api_errors
+
+
+@click.command()
+@click.argument("cluster-id", required=True)
+@click.option(
+    "--json",
+    is_flag=True,
+    help="Output in JSON format",
+)
+@click.pass_context
+@handle_api_errors("Clusters")
+def retrieve(ctx: click.Context, cluster_id: str, json: bool) -> None:
+    """Retrieve a cluster by ID"""
+    client: Together = ctx.obj
+
+    if not json:
+        click.echo(f"Clusters: Retrieving cluster...")
+
+    response = client.beta.clusters.retrieve(cluster_id)
+
+    if json:
+        click.echo(json_lib.dumps(response.model_dump(exclude_none=True), indent=4))
+    else:
+        print(response)

together/lib/cli/api/beta/clusters/storage/__init__.py

@@ -0,0 +1,19 @@
+import click
+
+from .list import list
+from .create import create
+from .delete import delete
+from .retrieve import retrieve
+
+
+@click.group()
+@click.pass_context
+def storage(ctx: click.Context) -> None:
+    """Clusters Storage API commands"""
+    pass
+
+
+storage.add_command(create)
+storage.add_command(retrieve)
+storage.add_command(delete)
+storage.add_command(list)

together/lib/cli/api/beta/clusters/storage/create.py

@@ -0,0 +1,49 @@
+import json as json_lib
+
+import click
+
+from together import Together
+from together.lib.cli.api._utils import handle_api_errors
+
+
+@click.command()
+@click.option(
+    "--region",
+    required=True,
+    type=str,
+    help="Region to create the storage volume in",
+)
+@click.option(
+    "--size-tib",
+    required=True,
+    type=int,
+    help="Size of the storage volume in TiB",
+)
+@click.option(
+    "--volume-name",
+    required=True,
+    type=str,
+    help="Name of the storage volume",
+)
+@click.option(
+    "--json",
+    is_flag=True,
+    help="Output in JSON format",
+)
+@click.pass_context
+@handle_api_errors("Clusters Storage")
+def create(ctx: click.Context, region: str, size_tib: int, volume_name: str, json: bool) -> None:
+    """Create a storage volume"""
+    client: Together = ctx.obj
+
+    response = client.beta.clusters.storage.create(
+        region=region,
+        size_tib=size_tib,
+        volume_name=volume_name,
+    )
+
+    if json:
+        click.echo(json_lib.dumps(response.model_dump_json(), indent=2))
+    else:
+        click.echo(f"Storage volume created successfully")
+        click.echo(response.volume_id)

together/lib/cli/api/beta/clusters/storage/delete.py

@@ -0,0 +1,38 @@
+import json as json_lib
+
+import click
+
+from together import Together
+from together.lib.cli.api._utils import handle_api_errors
+
+
+@click.command()
+@click.argument(
+    "volume-id",
+    required=True,
+)
+@click.option(
+    "--json",
+    is_flag=True,
+    help="Output in JSON format",
+)
+@click.pass_context
+@handle_api_errors("Clusters Storage")
+def delete(ctx: click.Context, volume_id: str, json: bool) -> None:
+    """Delete a storage volume"""
+    client: Together = ctx.obj
+
+    if json:
+        response = client.beta.clusters.storage.delete(volume_id)
+        click.echo(json_lib.dumps(response.model_dump(), indent=2))
+        return
+
+    storage = client.beta.clusters.storage.retrieve(volume_id)
+    ctx.obj.print_storage([storage])
+    if not click.confirm(f"Clusters Storage: Are you sure you want to delete storage volume {storage.volume_name}?"):
+        return
+
+    click.echo("Clusters Storage: Deleting storage volume...")
+    response = client.beta.clusters.storage.delete(volume_id)
+
+    click.echo(f"Clusters Storage: Deleted storage volume {storage.volume_name}")

together/lib/cli/api/beta/clusters/storage/list.py

@@ -0,0 +1,42 @@
+import json as json_lib
+from typing import Any, Dict, List
+
+import click
+from tabulate import tabulate
+
+from together import Together
+from together.lib.cli.api._utils import handle_api_errors
+from together.types.beta.clusters import ClusterStorage
+
+
+def print_storage(storage: List[ClusterStorage]) -> None:
+    data: List[Dict[str, Any]] = []
+    for volume in storage:
+        data.append(
+            {
+                "ID": volume.volume_id,
+                "Name": volume.volume_name,
+                "Size": volume.size_tib,
+            }
+        )
+    click.echo(tabulate(data, headers="keys", tablefmt="grid"))
+
+
+@click.command()
+@click.option(
+    "--json",
+    is_flag=True,
+    help="Output in JSON format",
+)
+@click.pass_context
+@handle_api_errors("Clusters Storage")
+def list(ctx: click.Context, json: bool) -> None:
+    """List storage volumes"""
+    client: Together = ctx.obj
+
+    response = client.beta.clusters.storage.list()
+
+    if json:
+        click.echo(json_lib.dumps(response.model_dump(), indent=2))
+    else:
+        print_storage(response.volumes)

together/lib/cli/api/beta/clusters/storage/retrieve.py

@@ -0,0 +1,34 @@
+import json as json_lib
+
+import click
+from rich import print
+
+from together import Together
+from together.lib.cli.api._utils import handle_api_errors
+
+
+@click.command()
+@click.argument(
+    "volume-id",
+    required=True,
+)
+@click.option(
+    "--json",
+    is_flag=True,
+    help="Output in JSON format",
+)
+@click.pass_context
+@handle_api_errors("Clusters Storage")
+def retrieve(ctx: click.Context, volume_id: str, json: bool) -> None:
+    """Retrieve a storage volume"""
+    client: Together = ctx.obj
+
+    if not json:
+        click.echo(f"Clusters Storage: Retrieving storage volume...")
+
+    response = client.beta.clusters.storage.retrieve(volume_id)
+
+    if json:
+        click.echo(json_lib.dumps(response.model_dump(), indent=2))
+    else:
+        print(response)