Make login and logout be run by click

Author: BartoszCki

paperspace/cli.py

@@ -7,7 +7,7 @@
 
 from paperspace import constants, client, config
 from paperspace.commands import experiments as experiments_commands, deployments as deployments_commands, \
-    machines as machines_commands
+    machines as machines_commands, login as login_commands
 
 
 class ChoiceType(click.Choice):
@@ -1071,3 +1071,36 @@ def wait_for_machine_state(machine_id, state, api_key):
     machines_api = client.API(config.CONFIG_HOST, api_key=api_key)
     command = machines_commands.WaitForMachineStateCommand(api=machines_api)
     command.execute(machine_id, state)
+
+
+@cli.command("login", help="Log in with email and password")
+@click.option(
+    "--email",
+    "email",
+    required=True,
+    callback=validate_email,
+    help="Email used to create Paperspace account",
+)
+@click.option(
+    "--password",
+    "password",
+    prompt=True,
+    hide_input=True,
+    help="Password used to create Paperspace account",
+)
+@click.option(
+    "--apiTokenName",
+    "api_token_name",
+    help="Name of api token used to log in",
+)
+def login(email, password, api_token_name):
+    machines_api = client.API(config.CONFIG_HOST)
+    command = login_commands.LogInCommand(api=machines_api)
+    command.execute(email, password, api_token_name)
+
+
+@cli.command("logout", help="Log out / remove apiKey from config file")
+def logout():
+    machines_api = client.API(config.CONFIG_HOST)
+    command = login_commands.LogOutCommand(api=machines_api)
+    command.execute()

paperspace/commands/__init__.py

@@ -0,0 +1,7 @@
+from paperspace import logger
+
+
+class CommandBase(object):
+    def __init__(self, api=None, logger_=logger):
+        self.api = api
+        self.logger = logger_

paperspace/commands/deployments.py

@@ -3,6 +3,7 @@
 import terminaltables
 
 from paperspace import config, version, client, logger
+from paperspace.commands import CommandBase
 from paperspace.utils import get_terminal_lines
 
 default_headers = {"X-API-Key": config.PAPERSPACE_API_KEY,
@@ -11,11 +12,7 @@
 deployments_api = client.API(config.CONFIG_HOST, headers=default_headers)
 
 
-class _DeploymentCommandBase(object):
-    def __init__(self, api=deployments_api, logger_=logger):
-        self.api = api
-        self.logger = logger_
-
+class _DeploymentCommandBase(CommandBase):
     def _log_message(self, response, success_msg_template, error_msg):
         if response.ok:
             try:

paperspace/commands/login.py

@@ -0,0 +1,14 @@
+from paperspace import login, logout
+from paperspace.commands import CommandBase
+
+
+class LogInCommand(CommandBase):
+    def execute(self, email, password, api_token_name=None):
+        login(email, password, api_token_name)
+
+
+class LogOutCommand(CommandBase):
+    def execute(self):
+        logout()
+
+

paperspace/commands/machines.py

@@ -3,16 +3,12 @@
 
 import terminaltables
 
-from paperspace import logger
+from paperspace.commands import CommandBase
 from paperspace.exceptions import BadResponse
 from paperspace.utils import get_terminal_lines
 
 
-class CommandBase(object):
-    def __init__(self, api=None, logger_=logger):
-        self.api = api
-        self.logger = logger_
-
+class _MachinesCommandBase(CommandBase):
     def _log_message(self, response, success_msg_template, error_msg):
         if response.ok:
             try:
@@ -30,7 +26,7 @@ def _log_message(self, response, success_msg_template, error_msg):
                 self.logger.log(error_msg)
 
 
-class CheckAvailabilityCommand(CommandBase):
+class CheckAvailabilityCommand(_MachinesCommandBase):
     def execute(self, region, machine_type):
         params = {"region": region,
                   "machineType": machine_type}
@@ -40,15 +36,15 @@ def execute(self, region, machine_type):
                           "Unknown error while checking machine availability")
 
 
-class CreateMachineCommand(CommandBase):
+class CreateMachineCommand(_MachinesCommandBase):
     def execute(self, kwargs):
         response = self.api.post("/machines/createSingleMachinePublic/", json=kwargs)
         self._log_message(response,
                           "New machine created with id: {id}",
                           "Unknown error while creating machine")
 
 
-class UpdateMachineCommand(CommandBase):
+class UpdateMachineCommand(_MachinesCommandBase):
     def execute(self, machine_id, kwargs):
         url = "/machines/{}/updateMachinePublic/".format(machine_id)
         response = self.api.post(url, json=kwargs)
@@ -57,7 +53,7 @@ def execute(self, machine_id, kwargs):
                           "Unknown error while updating machine")
 
 
-class StartMachineCommand(CommandBase):
+class StartMachineCommand(_MachinesCommandBase):
     def execute(self, machine_id):
         url = "/machines/{}/start/".format(machine_id)
         response = self.api.post(url)
@@ -66,7 +62,7 @@ def execute(self, machine_id):
                           "Unknown error while starting the machine")
 
 
-class StopMachineCommand(CommandBase):
+class StopMachineCommand(_MachinesCommandBase):
     def execute(self, machine_id):
         url = "/machines/{}/stop/".format(machine_id)
         response = self.api.post(url)
@@ -75,7 +71,7 @@ def execute(self, machine_id):
                           "Unknown error while stopping the machine")
 
 
-class RestartMachineCommand(CommandBase):
+class RestartMachineCommand(_MachinesCommandBase):
     def execute(self, machine_id):
         url = "/machines/{}/restart/".format(machine_id)
         response = self.api.post(url)
@@ -84,7 +80,7 @@ def execute(self, machine_id):
                           "Unknown error while restarting the machine")
 
 
-class ShowMachineCommand(CommandBase):
+class ShowMachineCommand(_MachinesCommandBase):
     def execute(self, machine_id):
         params = {"machineId": machine_id}
         response = self.api.get("/machines/getMachinePublic/", params=params)
@@ -142,7 +138,7 @@ def make_details_table(machine):
         return table_string
 
 
-class ListMachinesCommand(CommandBase):
+class ListMachinesCommand(_MachinesCommandBase):
     def execute(self, kwargs):
         json_ = {"params": kwargs} if kwargs else None
         response = self.api.get("/machines/getMachines/", json=json_)
@@ -186,7 +182,7 @@ def _make_machines_list_table(machines):
         return table_string
 
 
-class DestroyMachineCommand(CommandBase):
+class DestroyMachineCommand(_MachinesCommandBase):
     def execute(self, machine_id, release_public_ip):
         json_ = {"releasePublicIp": release_public_ip} if release_public_ip else None
         url = "/machines/{}/destroyMachine/".format(machine_id)
@@ -196,7 +192,7 @@ def execute(self, machine_id, release_public_ip):
                           "Unknown error while destroying the machine")
 
 
-class ShowMachineUtilisationCommand(CommandBase):
+class ShowMachineUtilisationCommand(_MachinesCommandBase):
     def execute(self, machine_id, billing_month):
         params = {"machineId": machine_id,
                   "billingMonth": billing_month}
@@ -227,7 +223,7 @@ def make_details_table(machine):
         return table_string
 
 
-class WaitForMachineStateCommand(CommandBase):
+class WaitForMachineStateCommand(_MachinesCommandBase):
     def execute(self, machine_id, state, interval=5):
         while True:
             try:

paperspace/main.py

@@ -3,12 +3,12 @@
 
 from .cli import cli
 from .jobs import run, print_json_pretty
-from .login import login, logout, set_apikey
+from .login import set_apikey
 from .version import version
 
 
 def main():
-    if len(sys.argv) >= 2 and sys.argv[1] in ('experiments', 'deployments', 'machines'):
+    if len(sys.argv) >= 2 and sys.argv[1] in ('experiments', 'deployments', 'machines', 'login', 'logout'):
         cli(sys.argv[1:])
 
     args = sys.argv[:]
@@ -30,35 +30,6 @@ def main():
         vers(prog)
         sys.exit(0)
 
-    if cmd == 'login':
-        email = None
-        password = None
-        apiToken = None
-        while args:
-            opt = args.pop(0)
-            if opt in help_opts:
-                print('usage: %s' % login_usage(prog))
-                sys.exit(0)
-            elif opt == '--email':
-                email = args.pop(0) if args else None
-            elif opt == '--password':
-                password = args.pop(0) if args else None
-            elif opt == '--apiToken':
-                apiToken = args.pop(0) if args else None
-            elif not email:
-                email = opt
-            elif not password:
-                password = opt
-            elif not apiToken:
-                apiToken = opt
-        return not login(email, password, apiToken)
-
-    if cmd == 'logout':
-        if args:
-            print('usage: %s logout' % prog)
-            sys.exit(not (args[0] in help_opts))
-        return not logout()
-
     if cmd == 'apikey' or cmd == 'apiKey':
         if not args or args[0] in help_opts:
             print('usage: %s' % apikey_usage(prog))