[ADD] implemented deleteproject operation & add mypy and isort, add type def

Author: bnbong

pdm.lock

@@ -12,6 +12,8 @@ dependencies = [
     "black>=24.10.0",
     "pre-commit>=4.0.1",
     "pytest-cov>=5.0.0",
+    "mypy>=1.12.0",
+    "isort>=5.13.2",
 ]
 requires-python = ">=3.12"
 readme = "README.md"
@@ -32,3 +34,15 @@ distribution = true
 [tool.pytest.ini_options]
 testpaths = ["test"]
 python_files = "test_*.py"
+
+[tool.mypy]
+strict = true
+
+[[tool.mypy.overrides]]
+module = "fastapi_fastkit.cli"
+disable_error_code = ["func-returns-value"]
+
+[[tool.mypy.overrides]]
+module = "fastapi_fastkit.core"
+ignore_missing_imports = true
+check_untyped_defs = false

pyproject.toml

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -x
+
+# shellcheck disable=SC2046
+base_dir=$(dirname $(dirname $0))
+
+black --config "${base_dir}/pyproject.toml" --check .
+black .

scripts/format.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+set -x
+
+# shellcheck disable=SC2046
+base_dir=$(dirname $(dirname $0))
+
+isort --sp "${base_dir}/pyproject.toml" --check .
+
+black --config "${base_dir}/pyproject.toml" --check .
+
+mypy --config-file "${base_dir}/pyproject.toml" src

scripts/lint.sh

@@ -3,6 +3,6 @@
 #
 # @author bnbong
 # --------------------------------------------------------------------------
-from cli import fastkit_cli
+from fastapi_fastkit.cli import fastkit_cli
 
 fastkit_cli()

src/fastapi_fastkit/__main__.py

@@ -8,7 +8,7 @@
 import os
 import click
 
-from typing import Union
+from typing import Union, Any
 
 from logging import getLogger
 
@@ -22,6 +22,7 @@
 from fastapi_fastkit.core.settings import FastkitConfig
 from fastapi_fastkit.core.exceptions import CLIExceptions, TemplateExceptions
 from fastapi_fastkit.utils.transducer import copy_and_convert_template
+from fastapi_fastkit.utils.inspector import delete_project
 
 
 logger = getLogger(__name__)
@@ -33,7 +34,7 @@
 REGEX = r"\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,7}\b"
 
 
-def validate_email(ctx, param, value):
+def validate_email(ctx: Context, param: Any, value: Any) -> Any:
     """
     Check if the provided email is in a valid format.
     This will recursively loop until a valid email input entry is given.
@@ -131,7 +132,7 @@ def fastkit_cli(ctx: Context, debug: bool) -> Union["BaseCommand", None]:
 
     setup_logging(settings=settings)
 
-    return
+    return None
 
 
 @fastkit_cli.command()
@@ -239,8 +240,6 @@ def startproject(
 
         copy_and_convert_template(target_template, project_dir, project_name)
 
-        # _new_user_local = os.path.join(user_local, template)
-
         _inject_project_metadata(
             project_dir, project_name, author, author_email, description
         )
@@ -253,10 +252,34 @@ def startproject(
 
 
 @fastkit_cli.command()
+@click.argument("project_name")
 @click.pass_context
-def deleteproject(ctx: Context) -> None:
-    # TODO : implement this
-    pass
+def deleteproject(ctx: Context, project_name: str) -> None:
+    settings = ctx.obj["settings"]
+
+    user_local = settings.USER_WORKSPACE
+    project_dir = os.path.join(user_local, project_name)
+
+    if not os.path.exists(project_dir):
+        click.echo(f"Error: Project '{project_name}' does not exist at '{user_local}'.")
+        return
+
+    confirm = click.confirm(
+        f"\nAre you sure you want to delete the project '{project_name}' at '{project_dir}'?",
+        default=False,
+    )
+    if not confirm:
+        click.echo("Project deletion aborted!")
+        return
+
+    try:
+        # TODO : adjust this
+        delete_project(project_dir)
+        click.echo(
+            f"Project '{project_name}' has been successfully deleted from '{user_local}'."
+        )
+    except Exception as e:
+        click.echo(f"Error during project deletion: {e}")
 
 
 @fastkit_cli.command()

src/fastapi_fastkit/cli.py

@@ -12,10 +12,10 @@
 
 class FastkitConfig:
     # Overridable values
-    FASTKIT_PROJECT_ROOT: str = None  # default : None (will be overridden)
-    FASTKIT_TEMPLATE_ROOT: str = None  # default : None (will be overridden)
-    LOG_FILE_PATH: str = None  # default : None (will be overridden)
-    USER_WORKSPACE: str = None  # default : None (will be overridden)
+    FASTKIT_PROJECT_ROOT: str = ""  # default : None (will be overridden)
+    FASTKIT_TEMPLATE_ROOT: str = ""  # default : None (will be overridden)
+    LOG_FILE_PATH: str = ""  # default : None (will be overridden)
+    USER_WORKSPACE: str = ""  # default : None (will be overridden)
 
     # Default Options
     DEBUG_MODE: bool = False
@@ -38,7 +38,7 @@ def __get_fastapi_fastkit_root() -> Path:
         return Path(__file__).parent.parent.parent.parent
 
     @classmethod
-    def __init__(cls):
+    def __init__(cls) -> None:
         """
         Initialize the configuration by performing important checks and setups.
         Override directories to correct position.

src/fastapi_fastkit/core/settings.py

@@ -4,3 +4,9 @@
 #
 # @author bnbong
 # --------------------------------------------------------------------------
+import shutil
+
+
+def delete_project(project_dir: str) -> None:
+    # TODO : add checking step -> preventing 'template' folder deletion.
+    shutil.rmtree(project_dir)

src/fastapi_fastkit/utils/inspector.py

@@ -26,7 +26,9 @@ def _convert_tpl_to_real_extension(file_path: str) -> str:
     return file_path
 
 
-def copy_and_convert_template(template_dir: str, target_dir: str, project_name: str = None) -> None:
+def copy_and_convert_template(
+    template_dir: str, target_dir: str, project_name: str = ""
+) -> None:
     """
     Copies all files from the template directory to the target directory,
     converting any files ending in `.*-tpl` during the copy process.