Merge branch 'development' of github.com:Paperspace/paperspace-python into PS-9868

# Conflicts:
#	Pipfile
#	Pipfile.lock
#	paperspace/cli/cli.py
#	setup.py
#	tests/example_responses.py

Author: MudlaffP

Pipfile

@@ -13,6 +13,8 @@ six = "*"
 gradient-statsd = "*"
 click = "*"
 terminaltables = "*"
+click-didyoumean = "*"
+click-help-colors = "*"
 colorclass = "*"
 tox = "*"
 

Pipfile.lock

@@ -1,7 +1,7 @@
 Paperspace Python
 =================
 
-Release 0.1.0a0
+Release 0.1.0
 
 See [releasenotes.md](https://github.com/Paperspace/paperspace-python/blob/master/releasenotes.md) for details on the current release, as well as release history.
 

README.md

@@ -4,9 +4,11 @@
 import click
 
 from paperspace import constants, client, config
+from paperspace.cli import common
 from paperspace.cli.common import api_key_option, del_if_value_is_none
 from paperspace.cli.jobs import jobs_group
 from paperspace.cli.logs import logs_group
+from paperspace.cli.models import models_group
 from paperspace.cli.projects import projects_group
 from paperspace.cli.cli_types import ChoiceType, json_string
 from paperspace.cli.validators import validate_mutually_exclusive, validate_email
@@ -21,22 +23,22 @@
 )
 
 
-@click.group()
+@click.group(cls=common.ClickGroup, **config.HELP_COLORS_DICT)
 def cli():
     pass
 
 
-@cli.group("experiments", help="Manage experiments")
+@cli.group("experiments", help="Manage experiments", cls=common.ClickGroup)
 def experiments():
     pass
 
 
-@experiments.group("create", help="Create new experiment")
+@experiments.group("create", help="Create new experiment", cls=common.ClickGroup)
 def create_experiment():
     pass
 
 
-@experiments.group(name="createAndStart", help="Create and start new experiment")
+@experiments.group(name="createAndStart", help="Create and start new experiment", cls=common.ClickGroup)
 def create_and_start_experiment():
     pass
 
@@ -328,7 +330,7 @@ def get_experiment_details(experiment_handle, api_key):
 )
 
 
-@cli.group("deployments", help="Manage deployments")
+@cli.group("deployments", help="Manage deployments", cls=common.ClickGroup)
 def deployments():
     pass
 
@@ -401,12 +403,22 @@ def create_deployment(api_key=None, **kwargs):
     type=ChoiceType(DEPLOYMENT_STATES_MAP, case_sensitive=False),
     help="Filter by deployment state",
 )
+@click.option(
+    "--projectId",
+    "projectId",
+    help="Use to filter by project ID",
+)
+@click.option(
+    "--modelId",
+    "modelId",
+    help="Use to filter by project ID",
+)
 @api_key_option
-def get_deployments_list(api_key=None, **kwargs):
-    del_if_value_is_none(kwargs)
+def get_deployments_list(api_key=None, **filters):
+    del_if_value_is_none(filters)
     deployments_api = client.API(config.CONFIG_HOST, api_key=api_key)
     command = deployments_commands.ListDeploymentsCommand(api=deployments_api)
-    command.execute(kwargs)
+    command.execute(filters)
 
 
 @deployments.command("update", help="Update deployment properties")
@@ -446,7 +458,7 @@ def get_deployments_list(api_key=None, **kwargs):
 def update_deployment_model(id_, api_key, **kwargs):
     del_if_value_is_none(kwargs)
     deployments_api = client.API(config.CONFIG_HOST, api_key=api_key)
-    command = deployments_commands.UpdateModelCommand(api=deployments_api)
+    command = deployments_commands.UpdateDeploymentCommand(api=deployments_api)
     command.execute(id_, kwargs)
 
 
@@ -487,7 +499,7 @@ def delete_deployment(id_, api_key=None):
 )
 
 
-@cli.group("machines", help="Manage machines")
+@cli.group("machines", help="Manage machines", cls=common.ClickGroup)
 def machines_group():
     pass
 
@@ -1055,6 +1067,7 @@ def version():
 
 cli.add_command(jobs_group)
 cli.add_command(projects_group)
+cli.add_command(models_group)
 cli.add_command(logs_group)
 
 

paperspace/cli/cli.py

@@ -1,4 +1,6 @@
 import click
+from click_didyoumean import DYMMixin
+from click_help_colors import HelpColorsGroup
 
 api_key_option = click.option(
     "--apiKey",
@@ -11,4 +13,8 @@ def del_if_value_is_none(dict_):
     """Remove all elements with value == None"""
     for key, val in list(dict_.items()):
         if val is None:
-            del dict_[key]
+            del dict_[key]
+
+
+class ClickGroup(DYMMixin, HelpColorsGroup):
+    pass

paperspace/cli/common.py

@@ -5,7 +5,7 @@
 from paperspace.commands import jobs as jobs_commands
 
 
-@click.group("jobs", help="Manage gradient jobs")
+@click.group("jobs", help="Manage gradient jobs", cls=common.ClickGroup)
 def jobs_group():
     pass
 

paperspace/cli/jobs.py

@@ -0,0 +1,29 @@
+import click
+
+from paperspace import client, config
+from paperspace.cli import common
+from paperspace.commands import models as models_commands
+
+
+@click.group("models", help="Manage models", cls=common.ClickGroup)
+def models_group():
+    pass
+
+
+@models_group.command("list", help="List models with optional filtering")
+@click.option(
+    "--experimentId",
+    "experimentId",
+    help="Use to filter by experiment ID",
+)
+@click.option(
+    "--projectId",
+    "projectId",
+    help="Use to filter by project ID",
+)
+@common.api_key_option
+def list_models(api_key, **filters):
+    common.del_if_value_is_none(filters)
+    models_api = client.API(config.CONFIG_HOST, api_key=api_key)
+    command = models_commands.ListModelsCommand(api=models_api)
+    command.execute(filters)

paperspace/cli/models.py

@@ -5,7 +5,7 @@
 from . import common
 
 
-@click.group("projects", help="Manage projects")
+@click.group("projects", help="Manage projects", cls=common.ClickGroup)
 def projects_group():
     pass
 

paperspace/cli/projects.py

@@ -19,7 +19,7 @@ def _log_message(self, response, success_msg_template, error_msg):
                 j = response.json()
                 handle = j["deployment"]
             except (ValueError, KeyError):
-                self.logger.log(success_msg_template)
+                self.logger.error(success_msg_template)
             else:
                 msg = success_msg_template.format(**handle)
                 self.logger.log(msg)
@@ -28,7 +28,7 @@ def _log_message(self, response, success_msg_template, error_msg):
                 data = response.json()
                 self.logger.log_error_response(data)
             except ValueError:
-                self.logger.log(error_msg)
+                self.logger.error(error_msg)
 
 
 class CreateDeploymentCommand(_DeploymentCommandBase):
@@ -40,25 +40,28 @@ def execute(self, kwargs):
 
 
 class ListDeploymentsCommand(_DeploymentCommandBase):
-    def execute(self, kwargs):
-        json_ = self._get_request_json(kwargs)
+    def execute(self, filters=None):
+        json_ = self._get_request_json(filters)
         response = self.api.get("/deployments/getDeploymentList/", json=json_)
 
         try:
+            data = response.json()
+            if not response.ok:
+                self.logger.log_error_response(data)
+                return
             deployments = self._get_deployments_list(response)
         except (ValueError, KeyError) as e:
-            self.logger.log("Error while parsing response data: {}".format(e))
+            self.logger.error("Error while parsing response data: {}".format(e))
         else:
             self._log_deployments_list(deployments)
 
     @staticmethod
-    def _get_request_json(kwargs):
-        state = kwargs.get("state")
-        if not state:
+    def _get_request_json(filters):
+        if not filters:
             return None
 
-        params = {"filter": {"where": {"and": [{"state": state}]}}}
-        return params
+        json_ = {"filter": {"where": {"and": [filters]}}}
+        return json_
 
     @staticmethod
     def _get_deployments_list(response):
@@ -71,7 +74,7 @@ def _get_deployments_list(response):
 
     def _log_deployments_list(self, deployments):
         if not deployments:
-            self.logger.log("No deployments found")
+            self.logger.warning("No deployments found")
         else:
             table_str = self._make_deployments_list_table(deployments)
             if len(table_str.splitlines()) > get_terminal_lines():
@@ -95,13 +98,13 @@ def _make_deployments_list_table(deployments):
         return table_string
 
 
-class UpdateModelCommand(_DeploymentCommandBase):
-    def execute(self, model_id, kwargs):
+class UpdateDeploymentCommand(_DeploymentCommandBase):
+    def execute(self, deployment_id, kwargs):
         if not kwargs:
             self.logger.log("No parameters to update were given. Use --help for more information.")
             return
 
-        json_ = {"id": model_id,
+        json_ = {"id": deployment_id,
                  "upd": kwargs}
         response = self.api.post("/deployments/updateDeployment/", json=json_)
         self._log_message(response,
@@ -110,8 +113,8 @@ def execute(self, model_id, kwargs):
 
 
 class StartDeploymentCommand(_DeploymentCommandBase):
-    def execute(self, model_id):
-        json_ = {"id": model_id,
+    def execute(self, deployment_id):
+        json_ = {"id": deployment_id,
                  "isRunning": True}
         response = self.api.post("/deployments/updateDeployment/", json=json_)
         self._log_message(response,
@@ -120,8 +123,8 @@ def execute(self, model_id):
 
 
 class DeleteDeploymentCommand(_DeploymentCommandBase):
-    def execute(self, model_id):
-        json_ = {"id": model_id,
+    def execute(self, deployment_id):
+        json_ = {"id": deployment_id,
                  "upd": {"isDeleted": True}}
         response = self.api.post("/deployments/updateDeployment/", json=json_)
         self._log_message(response,

paperspace/commands/deployments.py

@@ -20,7 +20,7 @@ def _log_create_experiment(response, success_msg_template, error_msg, logger_=lo
             data = response.json()
             logger_.log_error_response(data)
         except ValueError:
-            logger_.log(error_msg)
+            logger_.error(error_msg)
 
 
 def create_experiment(json_, api=experiments_api):
@@ -56,21 +56,20 @@ def __init__(self, api=experiments_api, logger_=logger):
         self.logger = logger_
 
     def execute(self, project_handles=None):
+        project_handles = project_handles or []
         params = self._get_query_params(project_handles)
         response = self.api.get("/experiments/", params=params)
 
         try:
             experiments = self._get_experiments_list(response, bool(project_handles))
         except (ValueError, KeyError) as e:
-            self.logger.log("Error while parsing response data: {}".format(e))
+            self.logger.error("Error while parsing response data: {}".format(e))
         else:
             self._log_experiments_list(experiments)
 
     @staticmethod
     def _get_query_params(project_handles):
-        # TODO: change to limit: -1 when PS-9535 is deployed to production
-        # to list all experiments
-        params = {"limit": 1000000}
+        params = {"limit": -1}  # so the API sends back full list without pagination
         for i, handle in enumerate(project_handles):
             key = "projectHandle[{}]".format(i)
             params[key] = handle
@@ -107,7 +106,7 @@ def _get_experiments_list(response, filtered=False):
 
     def _log_experiments_list(self, experiments):
         if not experiments:
-            self.logger.log("No experiments found")
+            self.logger.warning("No experiments found")
         else:
             table_str = self._make_experiments_list_table(experiments)
             if len(table_str.splitlines()) > get_terminal_lines():
@@ -176,7 +175,6 @@ def get_experiment_details(experiment_handle, api=experiments_api):
             experiment = response.json()["data"]
             details = _make_details_table(experiment)
         except (ValueError, KeyError) as e:
-            logger.log("Error parsing response data")
-            logger.debug(e)
+            logger.error("Error parsing response data")
 
     log_response(response, details, "Unknown error while retrieving details of the experiment")