Merge pull request #8 from kieran-mackle/development

CLI improvements

src/cryptobots/_cli/cli.py

@@ -486,16 +486,12 @@ def stop():
 @click.command()
 def configure():
     """Configure the cryptobots environment."""
-    import ccxt
-    import autotrader
     from cryptobots._cli.utilities import (
         check_dir_exists,
         print_banner,
-        update_keys_config,
-        create_link,
         update_config,
         configure_keys,
-        add_project_dir,
+        manage_project_dir,
     )
 
     # Define paths
@@ -523,7 +519,7 @@ def configure():
         click.echo(welcome_msg)
 
     # Prompt for option
-    options = {1: "Add exchange keys", 2: "Add project directory"}
+    options = {1: "Manage exchange API keys", 2: "Manage projects"}
     options[len(options) + 1] = "Exit"
     options_msg = "Configuration options:\n" + "\n".join(
         [f"  [{k}] {v}" for k, v in options.items()]
@@ -542,7 +538,7 @@ def configure():
 
         case 2:
             # Add project directory
-            add_project_dir(home_dir=home_dir)
+            manage_project_dir(home_dir=home_dir)
 
         case _:
             # Exit

src/cryptobots/_cli/utilities.py

@@ -81,7 +81,7 @@ def update_keys_config(keys_config: dict, exchange: str):
             # This net has been configured already
             overwrite = click.prompt(
                 text=click.style(
-                    text=f"  You have already configured keys for {exchange} {net_key}. Would you like to continue and overwrite?",
+                    text=f"You have already configured keys for {exchange} {net_key}. Would you like to continue and overwrite?",
                     fg="green",
                 ),
                 default=True,
@@ -90,6 +90,24 @@ def update_keys_config(keys_config: dict, exchange: str):
                 # Exit
                 return keys_config
 
+            else:
+                # Delete this key?
+                delete = click.prompt(
+                    text=click.style(
+                        text=f"Would you like to delete this key?",
+                        fg="green",
+                    ),
+                    default=False,
+                )
+                if delete:
+                    # Remove from config then return
+                    keys_config[exchange_config_key].pop(net_key)
+                    if len(keys_config[exchange_config_key]) == 0:
+                        keys_config.pop(exchange_config_key)
+                    click.echo(f"Removed {exchange} {net_key} API key.")
+                    click.pause()
+                    return keys_config
+
     click.echo(f"  Configuring API keys for {exchange} {net_key}.")
     api_key = click.prompt(text="    Please enter your API key")
     secret = click.prompt(text="    Please enter your API secret", hide_input=True)
@@ -593,17 +611,38 @@ def update_config(config_filepath: str, update_time: Optional[bool] = True, **kw
     with open(config_filepath, "w") as f:
         json.dump(config, f, indent=2)
 
+    return config
 
-def configure_keys(home_dir: str):
-    click.clear()
-    print_banner()
 
-    # Display featured exchanges
+def configure_keys(home_dir: str):
+    """Configure exchange API keys."""
+    # Create features exchanges links
     bybit = create_link(url="https://www.bybit.com/invite?ref=7NDOBW", label="Bybit")
     featured_excahnges = (
         f"The following exchanges are featured by CryptoBots:\n - {bybit}\n"
     )
-    click.echo(featured_excahnges)
+
+    def clear_and_display(config: dict):
+        click.clear()
+        print_banner()
+
+        # Display configured exchanges
+        if len(config) > 0:
+            msg = "You have configured the following exchanges:\n"
+            for exchange, conf in config.items():
+                name = exchange.lower().split(":")[-1]
+                msg += f"  - {name}:\n"
+                for net, c in conf.items():
+                    msg += f"      {net}: {c['api_key']}\n"
+
+        else:
+            msg = (
+                "You have not added any exchanges yet. How about adding one of "
+                + "CryptoBots featured exchanges?\n\n"
+            )
+            msg += featured_excahnges
+
+        click.echo(msg)
 
     # Look for keys file
     keys_filepath = os.path.join(
@@ -616,8 +655,10 @@ def configure_keys(home_dir: str):
         # Create new file
         keys_config = {}
 
+    # Display configured exchanges
+    clear_and_display(keys_config)
+
     # Add keys for exchanges
-    click.echo("Configuring API keys")
     while True:
         valid_exchange = False
         while not valid_exchange:
@@ -634,6 +675,8 @@ def configure_keys(home_dir: str):
             valid_exchange = True
 
         keys_config = update_keys_config(keys_config, exchange)
+        write_yaml(keys_config, keys_filepath)
+        clear_and_display(keys_config)
 
         # Continue
         repeat = click.prompt(
@@ -645,28 +688,96 @@ def configure_keys(home_dir: str):
         if not repeat:
             break
 
-    write_yaml(keys_config, keys_filepath)
-    click.echo(f"Done configuring keys - written to {keys_filepath}.")
+    click.echo("Done configuring keys.")
 
 
-def add_project_dir(home_dir: str):
+def manage_project_dir(home_dir: str):
     """Add the path to a user defined project directory."""
-    project_dir_path = click.prompt(
-        text=click.style(
-            text="Enter the path to your project",
-            fg="green",
-        ),
-        type=click.Path(exists=True, file_okay=False, resolve_path=True),
-    )
 
-    # TODO - add project structure validity checks
-    project_name = os.path.basename(project_dir_path)
+    def clear_and_display(config: dict):
+        click.clear()
+        print_banner()
+
+        # Display added projects
+        if "projects" in config and len(config["projects"]) > 0:
+            msg = "You have added the following projects:\n"
+            for i, project in enumerate(config["projects"]):
+                msg += f"  [{i+1}] {project}\n"
+        else:
+            msg = "You have not added any projects yet."
+        click.echo(msg)
 
-    # Add project directory to configuration file
+    # Load configuration to display current projects
     config_filepath = os.path.join(home_dir, constants.CONFIG_FILE)
-    update_config(
-        config_filepath=config_filepath,
-        update_time=False,
-        project=(project_name, project_dir_path),
-    )
-    click.echo(f"Added {project_name} to your projects.")
+    if os.path.exists(config_filepath):
+        # Load existing config
+        with open(config_filepath, "r") as f:
+            config = json.load(f)
+
+    else:
+        # Config doesn't exist yet
+        config = {}
+
+    # Display added projects
+    clear_and_display(config)
+
+    # Prompt options
+    managing = True
+    while managing:
+        try:
+            selection: str = click.prompt(
+                text=click.style(
+                    text="Would you like to add or remove a project?",
+                    fg="green",
+                ),
+                type=click.Choice(["add", "remove"], case_sensitive=False),
+            )
+
+            if selection.lower() == "add":
+                # Prompt for project path
+                project_dir_path = click.prompt(
+                    text=click.style(
+                        text="Enter the path to your project",
+                        fg="green",
+                    ),
+                    type=click.Path(exists=True, file_okay=False, resolve_path=True),
+                )
+
+                # TODO - add project structure validity checks
+                project_name = os.path.basename(project_dir_path)
+
+                # Add project directory to configuration file
+                config = update_config(
+                    config_filepath=config_filepath,
+                    update_time=False,
+                    project=(project_name, project_dir_path),
+                )
+                click.echo(f"Added {project_name} to your projects.")
+                click.pause()
+                clear_and_display(config)
+
+            elif selection.lower() == "remove":
+                # Remove a project
+                project_to_remove = click.prompt(
+                    text=click.style(
+                        text="Enter the project number to remove",
+                        fg="green",
+                    ),
+                    type=click.IntRange(min=1, max=len(config["projects"])),
+                )
+
+                # Remove this from config
+                project_name = list(config["projects"])[project_to_remove - 1]
+                config["projects"].pop(project_name)
+
+                # Write updated config
+                with open(config_filepath, "w") as f:
+                    json.dump(config, f, indent=2)
+
+                click.echo(f"Removed {project_name} from your projects.")
+                click.pause()
+                clear_and_display(config)
+
+        except click.Abort:
+            click.echo("")
+            managing = False