Add jobs list command

Author: BartoszCki

paperspace/cli/jobs.py

@@ -1,7 +1,7 @@
 import click
 
 from paperspace import client, config
-from paperspace.cli.common import api_key_option
+from paperspace.cli import common
 from paperspace.commands import jobs as jobs_commands
 
 
@@ -16,7 +16,7 @@ def jobs_group():
     "job_id",
     required=True,
 )
-@api_key_option
+@common.api_key_option
 def delete_job(job_id, api_key=None):
     jobs_api = client.API(config.CONFIG_HOST, api_key=api_key)
     command = jobs_commands.DeleteJobCommand(api=jobs_api)
@@ -29,8 +29,16 @@ def delete_job(job_id, api_key=None):
     "job_id",
     required=True,
 )
-@api_key_option
+@common.api_key_option
 def stop_job(job_id, api_key=None):
     jobs_api = client.API(config.CONFIG_HOST, api_key=api_key)
     command = jobs_commands.StopJobCommand(api=jobs_api)
     command.execute(job_id)
+
+
+@jobs_group.command("list", help="List jobs with optional filtering")
+@common.api_key_option
+def list_jobs(api_key):
+    jobs_api = client.API(config.CONFIG_HOST, api_key=api_key)
+    command = jobs_commands.ListJobsCommand(api=jobs_api)
+    command.execute()

paperspace/commands/jobs.py

@@ -1,4 +1,9 @@
+import pydoc
+
+import terminaltables
+
 from paperspace.commands import CommandBase
+from paperspace.utils import get_terminal_lines
 
 
 class JobsCommandBase(CommandBase):
@@ -35,3 +40,44 @@ def execute(self, job_id):
         self._log_message(response,
                           "Job stopped",
                           "Unknown error while stopping job")
+
+
+class ListJobsCommand(JobsCommandBase):
+    def execute(self):
+        response = self.api.get("/jobs/getJobs/", json=None)
+
+        try:
+            data = response.json()
+            if not response.ok:
+                self.logger.log_error_response(data)
+                return
+        except (ValueError, KeyError) as e:
+            self.logger.log("Error while parsing response data: {}".format(e))
+        else:
+            self._log_jobs_list(data)
+
+    def _log_jobs_list(self, data):
+        if not data:
+            self.logger.log("No jobs found")
+        else:
+            table_str = self._make_table(data)
+            if len(table_str.splitlines()) > get_terminal_lines():
+                pydoc.pager(table_str)
+            else:
+                self.logger.log(table_str)
+
+    @staticmethod
+    def _make_table(jobs):
+        data = [("ID", "Name", "Project", "Cluster", "Machine Type", "Created")]
+        for job in jobs:
+            id_ = job.get("id")
+            name = job.get("name")
+            project = job.get("project")
+            cluster = job.get("cluster")
+            machine_type = job.get("machineType")
+            created = job.get("dtCreated")
+            data.append((id_, name, project, cluster, machine_type, created))
+
+        ascii_table = terminaltables.AsciiTable(data)
+        table_string = ascii_table.table
+        return table_string