Merge pull request #229 from Paperspace/PS-12943

Ps 12943

Author: mkulaczkowski

gradient/api_sdk/clients/clusters.py

@@ -0,0 +1,19 @@
+from gradient.api_sdk import repositories
+
+from gradient.api_sdk.clients.base_client import BaseClient
+
+
+class ClustersClient(BaseClient):
+    def list(self, limit=11, offset=0, **kwargs):
+        """
+        Get a list of clusters for your team
+
+        :param int limit: how many element to return on request
+        :param int offset: from what position we should return clusters
+
+        :return: clusters
+        :rtype: list
+        """
+        repository = repositories.ListClusters(api_key=self.api_key, logger=self.logger)
+        clusters = repository.list(limit=limit, offset=offset)
+        return clusters

gradient/api_sdk/models/__init__.py

@@ -1,4 +1,5 @@
 from .artifact import Artifact
+from .cluster import Cluster
 from .dataset import Dataset
 from .deployment import Deployment
 from .experiment import BaseExperiment, MultiNodeExperiment, SingleNodeExperiment, MpiMultiNodeExperiment

gradient/api_sdk/models/cluster.py

@@ -0,0 +1,8 @@
+import attr
+
+
+@attr.s
+class Cluster(object):
+    id = attr.ib(type=str, default=None)
+    name = attr.ib(type=str, default=None)
+    type = attr.ib(type=str, default=None)

gradient/api_sdk/repositories/__init__.py

@@ -1,3 +1,4 @@
+from .clusters import ListClusters
 from .deployments import ListDeployments, CreateDeployment, StartDeployment, StopDeployment, DeleteDeployment, \
     UpdateDeployment, GetDeployment
 from .experiments import ListExperiments, GetExperiment, ListExperimentLogs, StartExperiment, StopExperiment, \

gradient/api_sdk/repositories/clusters.py

@@ -1,5 +1,8 @@
+import json
+from collections import OrderedDict
+
 from gradient.api_sdk.config import config
-from gradient.api_sdk.repositories.common import GetResource
+from gradient.api_sdk.repositories.common import GetResource, ListResources
 from gradient.api_sdk.sdk_exceptions import MalformedResponseError
 from gradient.api_sdk.serializers.cluster import ClusterSchema
 
@@ -27,3 +30,26 @@ def _parse_object(self, instance_dict, **kwargs):
         if instance.errors:
             raise MalformedResponseError(instance.errors)
         return instance.data
+
+
+class ListClusters(ListResources):
+    SERIALIZER_CLS = ClusterSchema
+
+    def get_request_url(self, **kwargs):
+        return "/clusters/getClusters"
+
+    def _get_api_url(self, **kwargs):
+        return config.CONFIG_HOST
+
+    def _get_request_params(self, kwargs):
+        filter = OrderedDict({
+            "limit": kwargs.get("limit"),
+            "offset": kwargs.get("offset"),
+        })
+        filter["where"] = {
+            "isPrivate": True
+        }
+
+        return {
+            "filter": json.dumps(OrderedDict(filter))
+        }

gradient/api_sdk/serializers/cluster.py

@@ -1,9 +1,11 @@
 import marshmallow as ma
 
+from gradient.api_sdk import models
 from gradient.api_sdk.serializers.base import BaseSchema
 
 
 class ClusterSchema(BaseSchema):
+    MODEL = models.Cluster
     id = ma.fields.String()
     name = ma.fields.String()
     type = ma.fields.String()

gradient/cli/__init__.py

@@ -3,6 +3,7 @@
 from click._compat import get_text_stderr
 
 import gradient.cli.auth
+import gradient.cli.clusters
 import gradient.cli.deployments
 import gradient.cli.experiments
 import gradient.cli.hyperparameters

gradient/cli/clusters.py

@@ -0,0 +1,45 @@
+import click
+
+from gradient.api_sdk.clients.clusters import ClustersClient
+from gradient.cli import common
+from gradient.cli.cli import cli
+from gradient.cli.common import ClickGroup, api_key_option
+from gradient.commands.clusters import ListClustersCommand
+
+
+def get_clusters_client(api_key):
+    client = ClustersClient(api_key=api_key)
+    return client
+
+
+@cli.group("clusters", help="Manage clusters", cls=ClickGroup)
+def clusters():
+    pass
+
+@clusters.command("list", help="List your team clusters")
+@click.option(
+    "--limit",
+    "-l",
+    "cluster_limit",
+    default=20,
+    help="Limit listed experiments per page",
+    cls=common.GradientOption,
+)
+@click.option(
+    "--offset",
+    "-o",
+    "cluster_offset",
+    default=0,
+    cls=common.GradientOption,
+)
+@api_key_option
+@common.options_file
+def get_clusters_list(api_key, cluster_limit, cluster_offset, options_file):
+    command = ListClustersCommand(cluster_client=get_clusters_client(api_key))
+
+    res = command.execute(limit=cluster_limit, offset=cluster_offset)
+
+    for cluster_str, next_iteration in res:
+        click.echo(cluster_str)
+        if next_iteration:
+            click.confirm("Do you want to continue?", abort=True)

gradient/commands/clusters.py

@@ -0,0 +1,69 @@
+import abc
+
+import six
+from halo import halo
+
+from gradient import clilogger as gradient_logger, exceptions
+from gradient.api_sdk import sdk_exceptions
+from gradient.commands.common import ListCommandMixin
+
+
+@six.add_metaclass(abc.ABCMeta)
+class _ClustersCommand(object):
+    def __init__(self, cluster_client, logger_=gradient_logger.CliLogger()):
+        self.client = cluster_client
+        self.logger = logger_
+
+    @abc.abstractmethod
+    def execute(self, **kwargs):
+        pass
+
+
+class ListClustersCommand(ListCommandMixin, _ClustersCommand):
+    WAITING_FOR_RESPONSE_MESSAGE = "Waiting for data..."
+
+    def execute(self, **kwargs):
+        return self._generate_data_table(**kwargs)
+
+    def _get_instances(self, **kwargs):
+        try:
+            instances= self.client.list(**kwargs)
+        except sdk_exceptions.GradientSdkError as e:
+            raise exceptions.ReceivingDataFailedError(e)
+
+        return instances
+
+    def _get_table_data(self, objects):
+        data = [("ID", "Name", "Type")]
+
+        for cluster in objects:
+            handle = cluster.id
+            name = cluster.name
+            type = cluster.type
+            data.append((handle, name, type))
+        return data
+
+    def _generate_data_table(self, **kwargs):
+        limit = kwargs.get("limit")
+        offset = kwargs.get("offset")
+        next_iteration = True
+
+        while next_iteration:
+            with halo.Halo(text=self.WAITING_FOR_RESPONSE_MESSAGE, spinner="dots"):
+                kwargs["offset"] = offset
+                instances = self._get_instances(
+                    **kwargs
+                )
+            if instances:
+                table_data = self._get_table_data(instances)
+                table_str = self._make_list_table(table_data) + "\n"
+            else:
+                table_str = "No data found"
+
+            if len(instances) < limit:
+                next_iteration = False
+
+            yield table_str, next_iteration
+            offset += limit
+
+

tests/config_files/clusters_list.yaml

@@ -0,0 +1,2 @@
+apiKey: some_key
+limit: 2