New Command : type-fastapi standard (#4)

* add standard structure support

* added tests for standard

Author: kevinrawal

.gitignore

@@ -5,3 +5,6 @@ build
 dist
 
 # Files
+
+# virtual environment
+venv

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "type-fastapi"
-version = "0.1.1"
+version = "0.1.2"
 description = ""
 authors = ["KevinRawal <[email protected]>"]
 readme = "README.md"
@@ -16,6 +16,7 @@ pytest = "^8.3.3"
 
 [tool.poetry.group.dev.dependencies]
 pytest-cov = "^6.0.0"
+black = "^24.10.0"
 
 [build-system]
 requires = ["poetry-core"]

pyproject.toml

@@ -0,0 +1,48 @@
+import os
+import tempfile
+from typer.testing import CliRunner
+from type_fastapi.main import app
+
+def test_type_fastapi_standard():
+    """
+    Test the `standard` subcommand creates the expected files and directories.
+    """
+    # Create a temporary directory
+    with tempfile.TemporaryDirectory() as temp_dir:
+        # Change the current working directory to the temporary directory
+        current_dir = os.getcwd()
+        os.chdir(temp_dir)
+
+        try:
+            # Run the CLI command
+            runner = CliRunner()
+            result = runner.invoke(app, ["standard"])
+            assert result.exit_code == 0
+
+            # Check if all files and directories are created
+            expected_paths = [
+                "app/__init__.py",
+                "app/main.py",
+                "app/routers/__init__.py",
+                "app/services/__init__.py",
+                "app/schemas/__init__.py",
+                "app/models/__init__.py",
+                "app/external_services/__init__.py",
+                "app/config/__init__.py",
+                "app/config/database.py",
+                "app/utils/__init__.py",
+                "tests/__init__.py",
+                ".gitignore",
+                "requirements.txt",
+                "README.md",
+            ]
+
+            for path in expected_paths:
+                assert os.path.exists(path), f"File {path} was not created."
+
+        finally:
+            # Clean up: Restore the original working directory
+            os.chdir(current_dir)
+
+if __name__ == "__main__":
+    test_type_fastapi_standard()

tests/test_main.py

@@ -0,0 +1,33 @@
+import typer
+import os
+
+from type_fastapi.utils import create_structure
+
+
+def standard():
+    """
+    Create a standard FastAPI setup
+    """
+    base_dir = os.getcwd()  # Current working directory
+    structure = [
+        {
+            "app": [
+                "__init__.py",
+                "main.py",
+                {"routers": ["__init__.py"]},
+                {"services": ["__init__.py"]},
+                {"schemas": ["__init__.py"]},
+                {"models": ["__init__.py"]},
+                {"external_services": ["__init__.py"]},
+                {"config": ["__init__.py", "database.py"]},
+                {"utils": ["__init__.py"]},
+            ]
+        },
+        {"tests": ["__init__.py"]},
+        ".gitignore",
+        "requirements.txt",
+        "README.md",
+    ]
+
+    create_structure(base_dir, structure)
+    typer.echo("FastAPI project structure has been created successfully.")

tests/test_type_fastapi_standard.py

@@ -1,8 +1,10 @@
 import typer
-
+from type_fastapi.commands.standard import standard
 
 app = typer.Typer()
 
+app.command(name="standard")(standard)
+
 
 @app.callback()
 def callback():
@@ -11,10 +13,5 @@ def callback():
     """
 
 
-@app.command()
-def create_simple():
-    """
-    Create a simple FastAPI app
-    """
-    print("Create a simple FastAPI app")
-    pass
+if __name__ == "__main__":
+    app()

type_fastapi/commands/__init__.py

@@ -0,0 +1,48 @@
+import os
+import typer
+
+
+def create_structure(base, items):
+    """
+    Recursively create files and directories based on the given items.
+
+    Args:
+        base (str): The base directory to create the files and directories in.
+        items (list[Union[str, dict]]): The list of items to create. If an item is a
+            string, it is created as a file with the name being the value of the
+            string. If an item is a dictionary, it is created as a directory with
+            the key being the name of the directory and the value being the list of
+            subitems to create inside the directory.
+
+    Returns:
+        None
+    """
+    for item in items:
+        if isinstance(item, str):
+            # Create files
+            file_path = os.path.join(base, item)
+            if os.path.exists(file_path):
+                typer.secho(
+                    f"Warning: File already exists: {file_path}", fg=typer.colors.YELLOW
+                )
+            else:
+                with open(file_path, "w", encoding="utf-8") as f:
+                    if item == "README.md":
+                        f.write("# FastAPI Project\n\nThis is a FastAPI project.")
+                    elif item == "requirements.txt":
+                        f.write("fastapi\nuvicorn\n")  # Example dependencies
+                    elif item == ".gitignore":
+                        f.write("*.pyc\n__pycache__/\n.env\n")
+
+        elif isinstance(item, dict):
+            # Create directories recursively
+            for folder, subitems in item.items():
+                folder_path = os.path.join(base, folder)
+                if not os.path.exists(folder_path):
+                    os.makedirs(folder_path, exist_ok=True)
+                    create_structure(folder_path, subitems)
+                else:
+                    typer.secho(
+                        f"Warning: Directory already exists: {folder_path}",
+                        fg=typer.colors.YELLOW,
+                    )