Added small comments

Author: Dtar380

src/__main__.py

@@ -1,3 +1,6 @@
+#################################################
+# IMPORTS
+#################################################
 from __future__ import annotations
 
 from click import group
@@ -6,18 +9,25 @@
 from .cli.manager import Manager
 
 
+#################################################
+# CODE
+#################################################
+# Create the main group for the CLI
 @group()
 def cli() -> None:
     pass
 
 
+# Add the two command groups
 cli.add_command(Builder())
 cli.add_command(Manager())
 
 
+# Create the main entry point
 def main() -> None:
     cli()
 
 
+# Execute the programm
 if __name__ == "__main__":
     main()

src/cli/builder.py

@@ -1,3 +1,6 @@
+#################################################
+# IMPORTS
+#################################################
 from __future__ import annotations
 
 import inspect
@@ -13,6 +16,9 @@
 from .custom_group import CustomGroup
 from .menu import Menus
 
+#################################################
+# CODE
+#################################################
 dicts = dict[str, Any]
 
 

src/cli/custom_group.py

@@ -1,3 +1,6 @@
+#################################################
+# IMPORTS
+#################################################
 from __future__ import annotations
 
 import inspect
@@ -6,6 +9,9 @@
 from click import Command, Group
 
 
+#################################################
+# CODE
+#################################################
 class CustomGroup(Group):
 
     cwd: Path = Path.cwd()

src/cli/manager.py

@@ -1,3 +1,6 @@
+#################################################
+# IMPORTS
+#################################################
 from __future__ import annotations
 
 import inspect
@@ -10,6 +13,9 @@
 from .custom_group import CustomGroup
 
 
+#################################################
+# CODE
+#################################################
 class Manager(CustomGroup):
 
     def __init__(self) -> None:

src/cli/menu.py

@@ -1,3 +1,6 @@
+#################################################
+# IMPORTS
+#################################################
 from __future__ import annotations
 
 from typing import Any
@@ -9,6 +12,9 @@
 from ..utils.cli import clear, confirm
 
 
+#################################################
+# CODE
+#################################################
 class Menus:
 
     def __init__(

src/core/docker.py

@@ -1,3 +1,6 @@
+#################################################
+# IMPORTS
+#################################################
 from __future__ import annotations
 
 from pathlib import Path
@@ -10,6 +13,9 @@
 from .files import FileManager
 
 
+#################################################
+# CODE
+#################################################
 class ComposeManager:
 
     def __init__(self) -> None:

src/core/files.py

@@ -1,3 +1,6 @@
+#################################################
+# IMPORTS
+#################################################
 from __future__ import annotations
 
 import json
@@ -8,14 +11,24 @@
 import jinja2
 from yaspin import yaspin  # type: ignore
 
+#################################################
+# CODE
+#################################################
 dicts = dict[str, Any]
 
 
 class FileManager:
+    """
+    File manager class. Incharge of reading, writting and creating files.
+    """
 
     cwd = Path.cwd()
 
     def save_files(self, data: dicts, build: bool = False) -> None:
+        """
+        Create/Update files and save them. Also copies the asset files.
+        """
+
         tmps_path = files("minecraft-docker-cli.assets.templates")
         composer_template = tmps_path.joinpath("docker-compose.yml.j2")
         env_template = tmps_path.joinpath(".env.j2")

src/utils/cli.py

@@ -1,3 +1,6 @@
+#################################################
+# IMPORTS
+#################################################
 from __future__ import annotations
 
 from os import name, system
@@ -6,12 +9,21 @@
 from InquirerPy import inquirer  # type: ignore
 
 
+#################################################
+# CODE
+#################################################
 def clear(t: float) -> None:
+    """
+    Sleep t seconds and clear the console.
+    """
     sleep(t)
     system("cls" if name == "nt" else "clear")
 
 
 def confirm(msg: str, default: bool = False) -> bool:
+    """
+    Ask for confirmation with custom message and default value
+    """
     return inquirer.confirm(  # type: ignore
         message=msg, default=default
     ).execute()