[FEAT] add email validation feature, add current version printing method(need modifing)

Author: bnbong

src/fastapi_fastkit/cli.py

@@ -4,6 +4,7 @@
 #
 # @author bnbong bbbong9@gmail.com
 # --------------------------------------------------------------------------
+import re
 import os
 import click
 
@@ -29,6 +30,31 @@
 # --------------------------------------------------------------------------
 # Backend operators
 # --------------------------------------------------------------------------
+REGEX = r"\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,7}\b"
+
+
+def validate_email(ctx, param, value):
+    """
+    Check if the provided email is in a valid format.
+    This will recursively loop until a valid email input entry is given.
+
+    :param ctx: context of passing configurations (NOT specify it at CLI)
+    :type ctx: <Object click.Context>
+    :param param: parameters from CLI
+    :param value: values from CLI
+    :return:
+    """
+    try:
+        if not re.match(REGEX, value):
+            raise ValueError(value)
+        else:
+            return value
+    except ValueError as e:
+        click.echo("Incorrect email address given: {}".format(e))
+        value = click.prompt(param.prompt)
+        return validate_email(ctx, param, value)
+
+
 def _inject_project_metadata(
     target_dir: str,
     project_name: str,
@@ -71,11 +97,27 @@ def _inject_project_metadata(
         raise TemplateExceptions("ERROR : Having some errors with injecting metadata")
 
 
+def _print_version(ctx: Context, value: click.Option, *args, **kwargs) -> None:
+    # TODO : apply this at fastapi-cli group
+    """
+    print current version of fastapi-fastkit
+
+    :param ctx: context of passing configurations (NOT specify it at CLI)
+    :type ctx: <Object click.Context>
+    """
+    if value:
+        version_info = f"fastapi-fastkit version {__version__}"
+        click.echo(print(version_info))
+        ctx.exit()
+
+
 # --------------------------------------------------------------------------
 # Click operator methods
 # --------------------------------------------------------------------------
 @click.group()
 @click.option("--debug/--no-debug", default=False)
+# @click.option('--version', callback=_print_version,
+#               expose_value=False)
 @click.pass_context
 def fastkit_cli(ctx: Context, debug: bool) -> Union["BaseCommand", None]:
     """
@@ -138,7 +180,7 @@ def echo(ctx: Context) -> None:
 
 
 @fastkit_cli.command(context_settings={"ignore_unknown_options": True})
-@click.argument("template")
+@click.argument("template", default="fastapi-default")
 @click.option(
     "--project-name",
     prompt="Enter the project name",
@@ -151,6 +193,8 @@ def echo(ctx: Context) -> None:
     "--author-email",
     prompt="Enter the author email",
     help="The email of the project author.",
+    type=str,
+    callback=validate_email,
 )
 @click.option(
     "--description",
@@ -166,6 +210,7 @@ def startproject(
     author_email: str,
     description: str,
 ) -> None:
+    # TODO : add a feature - name project folder name to project_name
     """
     Create a new FastAPI project from templates and inject metadata.
 
@@ -179,22 +224,36 @@ def startproject(
     settings = ctx.obj["settings"]
 
     template_dir = settings.FASTKIT_TEMPLATE_ROOT
+    click.echo(f"Deploying FastAPI project using '{template}' template")
     target_template = os.path.join(template_dir, template)
     print(f"Template path: {target_template}")
 
     if not os.path.exists(target_template):
         raise CLIExceptions(
             f"Error: Template '{template}' does not exist in '{template_dir}'."
         )
+    # TODO : add confirm step : checking template stack & name & metadata, confirm it y/n
+    # click.echo("Project Stack: [FastAPI, Uvicorn, SQLAlchemy, Docker (optional)]")
+
+    confirm = click.confirm(
+        "\nDo you want to proceed with project creation?", default=False
+    )
+    if not confirm:
+        click.echo("Project creation aborted!")
+        return
 
     try:
         user_local = settings.USER_WORKSPACE
         click.echo(f"FastAPI template project will deploy at '{user_local}'")
 
         click.echo(f"Project Name: {project_name}")
 
-        # TODO : add confirm step : checking template stack & name & metadata, confirm it y/n
-        # click.echo("Project Stack: [FastAPI, Uvicorn, SQLAlchemy, Docker (optional)]")
+        confirm = click.confirm(
+            "\nDo you want to proceed with project creation?", default=False
+        )
+        if not confirm:
+            click.echo("Project creation aborted!")
+            return
 
         copy_and_convert_template(target_template, user_local)
 

tests/test_cli_operations/test_cli.py

@@ -52,13 +52,20 @@ def test_startproject(self, temp_dir) -> None:
         result = self.runner.invoke(
             fastkit_cli,  # type: ignore
             ["startproject", "fastapi-default"],
-            input='\n'.join(["test-project", "bnbong", "bbbong9@gmail.com", "test project"]),
+            input="\n".join(
+                ["test-project", "bnbong", "bbbong9@gmail.com", "test project"]
+            ),
         )
 
         # then
-        project_path = Path(temp_dir) / "fastapi-default"  # TODO : change this after adding folder naming feature.
+        project_path = (
+            Path(temp_dir) / "fastapi-default"
+        )  # TODO : change this after adding folder naming feature.
         assert project_path.exists() and project_path.is_dir()
-        assert f"FastAPI project 'test-project' from 'fastapi-default' has been created and saved to {temp_dir}!" in result.output
+        assert (
+            f"FastAPI project 'test-project' from 'fastapi-default' has been created and saved to {temp_dir}!"
+            in result.output
+        )
 
         expected_files = ["main.py", "setup.py"]
         for file in expected_files: