made changes to file structures and made docker a sub-group of cli main group.

Author: arsalan-dev-engineer

commands/docker/__init__.py

@@ -0,0 +1,26 @@
+import os
+
+def get_python_modules(path):
+    """
+    Recursively get a list of valid Python files to import as modules.
+    """
+    module_list = []
+    for root, dirs, files in os.walk(path):
+        for file in files:
+            if not file.startswith('-') and not file.startswith('.') and file.endswith('.py'):
+                # Exclude files starting with '-' and '.'
+                # Include only Python files ending with '.py'
+                file_path = os.path.join(root, file)
+                if os.path.isfile(file_path):
+                    # If it's a file, add it to the module list without the '.py' extension
+                    module_list.append(os.path.splitext(os.path.relpath(file_path, start=path))[0].replace(os.sep, '.'))
+    return module_list
+
+# Get the directory where this __init__.py is located
+directory = os.path.dirname(__file__)
+
+# Get the list of Python modules in the current directory and subdirectories
+module_list = get_python_modules(directory)
+
+# Use the generated module list for wildcard imports
+__all__ = module_list

commands/docker_cleanup.py commands/docker/cleanup.pycommands/docker_cleanup.py renamed to commands/docker/cleanup.py

@@ -71,7 +71,7 @@ def docker_connection_checker():
 @click.option("--verbose", is_flag=True, help="Enable verbose output.")
 @click.option("--log-level", type=click.Choice(["DEBUG", "INFO", "WARNING", "ERROR"], case_sensitive=False),
               default="INFO", help="Set the logging level.")
-def docker_cleanup(verbose, log_level):
+def cleanup(verbose, log_level):
     log_level = getattr(logging, log_level.upper(), logging.INFO)
     logger.setLevel(log_level)
     if verbose:
@@ -180,13 +180,13 @@ def prune_all(dry_run, force):
 
 # =============== ADDING COMMANDS TO GROUPS
 
-docker_cleanup.add_command(prune_containers)
-docker_cleanup.add_command(prune_images)
-docker_cleanup.add_command(prune_volumes)
-docker_cleanup.add_command(prune_networks)
-docker_cleanup.add_command(prune_all)
+cleanup.add_command(prune_containers)
+cleanup.add_command(prune_images)
+cleanup.add_command(prune_volumes)
+cleanup.add_command(prune_networks)
+cleanup.add_command(prune_all)
 
 # =============== SCRIPT ENTRYPOINT
 
 if __name__ == "__main__":
-    docker_cleanup()
+    cleanup()

dev_cli/dev_cli.py

@@ -5,27 +5,45 @@
 import sys
 from pathlib import Path
 
-# get current script directory
+# =============== PATH SETUP
+
 currentdir = Path(__file__).resolve().parent
-# get parent directory
 parentdir = currentdir.parent
 # add parent directory to sys.path
 sys.path.insert(0, str(parentdir))
 
-# import modules from commands.personal directory
-from commands import docker_cleanup
+# =============== IMPORTING DOCKER MODULES
+
+# import modules from commands.docker
+from commands.docker import cleanup
+
+# =============== CLI GROUP
 
-# define main command group for the CLI Tool
+# define main command group for the cli tool
 @click.group(help="dev-cli tool: a command-line interface for various devops utilities.")
 def cli():
     """Main entry point for dev-cli Tool."""
-     # function doesn't do anything.
-     # is REQUIRED for defining the command group
+    # function doesn't do anything.
+    # is REQUIRED for defining the command group
     pass
 
-cli.add_command(docker_cleanup.docker_cleanup)
+# =============== DOCKER SUB-GROUP
+
+# define docker command group
+@click.group(help="Commands for automating docker operations.")
+def docker():
+    pass
+
+# add commands to docker group
+docker.add_command(cleanup.cleanup)
+
+# =============== ADD SUB-GROUPS TO MAIN CLI GROUP
+
+# add docker group to the main cli group
+cli.add_command(docker)
+
+# =============== SCRIPT ENTRYPOINT
 
-# entry point of the script.
 # calls the cli tool if the script is executed.
 if __name__ == "__main__":
     cli()