FastAPI-fastkit 1.1.1__tar.gz → 1.1.3__tar.gz

{fastapi_fastkit-1.1.1 → fastapi_fastkit-1.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: FastAPI-fastkit
-Version: 1.1.1
+Version: 1.1.3
 Summary: Fast, easy-to-use starter kit for new users of Python and FastAPI
 Author-Email: bnbong <bbbong9@gmail.com>
 License: MIT

{fastapi_fastkit-1.1.1 → fastapi_fastkit-1.1.3}/pyproject.toml

@@ -11,7 +11,7 @@ dependencies = [
 ]
 requires-python = ">=3.12"
 readme = "README.md"
-version = "1.1.1"
+version = "1.1.3"
 
 [project.license]
 text = "MIT"

fastapi_fastkit-1.1.3/src/fastapi_fastkit/__init__.py

@@ -0,0 +1 @@
+__version__ = 'v1.1.3'

{fastapi_fastkit-1.1.1 → fastapi_fastkit-1.1.3}/src/fastapi_fastkit/backend/main.py

@@ -7,10 +7,15 @@ import os
 import re
 from typing import Dict, List
 
+import click
+
 from fastapi_fastkit import console
 from fastapi_fastkit.backend.package_managers import PackageManagerFactory
-from fastapi_fastkit.backend.transducer import copy_and_convert_template_file
-from fastapi_fastkit.core.exceptions import BackendExceptions, TemplateExceptions
+from fastapi_fastkit.backend.transducer import (
+    copy_and_convert_template,
+    copy_and_convert_template_file,
+)
+from fastapi_fastkit.core.exceptions import BackendExceptions
 from fastapi_fastkit.core.settings import settings
 from fastapi_fastkit.utils.logging import debug_log, get_logger
 from fastapi_fastkit.utils.main import (
@@ -697,3 +702,68 @@ def add_new_route(project_dir: str, route_name: str) -> None:
         debug_log(f"Unexpected error while adding route {route_name}: {e}", "error")
         handle_exception(e, f"Error adding new route: {str(e)}")
         raise BackendExceptions(f"Failed to add new route: {str(e)}")
+
+
+# ------------------------------------------------------------
+# Create Project Folder Functions
+# ------------------------------------------------------------
+
+
+def ask_create_project_folder(project_name: str) -> bool:
+    """
+    Ask user whether to create a new project folder.
+
+    :param project_name: Name of the project
+    :return: True if user wants to create a folder, False otherwise
+    """
+    return click.confirm(
+        f"\nCreate a new project folder named '{project_name}'?\n"
+        f"Yes: Templates will be placed in './{project_name}/'\n"
+        f"No: Templates will be placed in current directory",
+        default=True,
+    )
+
+
+def deploy_template_with_folder_option(
+    target_template: str, user_local: str, project_name: str, create_folder: bool
+) -> tuple[str, str]:
+    """
+    Deploy template based on folder creation option.
+
+    :param target_template: Path to template directory
+    :param user_local: User's workspace directory
+    :param project_name: Name of the project
+    :param create_folder: Whether to create a new folder
+    :return: Tuple of (project_dir, deployment_message)
+    """
+    if create_folder:
+        project_dir = os.path.join(user_local, project_name)
+        deployment_message = f"FastAPI template project will deploy at '{user_local}' in folder '{project_name}'"
+        copy_and_convert_template(target_template, user_local, project_name)
+    else:
+        project_dir = user_local
+        deployment_message = (
+            f"FastAPI template project will deploy directly at '{user_local}'"
+        )
+        copy_and_convert_template(target_template, user_local, "")
+
+    click.echo(deployment_message)
+    return project_dir, deployment_message
+
+
+def get_deployment_success_message(
+    template: str, project_name: str, user_local: str, create_folder: bool
+) -> str:
+    """
+    Get appropriate success message based on deployment option.
+
+    :param template: Template name used
+    :param project_name: Name of the project
+    :param user_local: User's workspace directory
+    :param create_folder: Whether folder was created
+    :return: Success message string
+    """
+    if create_folder:
+        return f"FastAPI project '{project_name}' from '{template}' has been created and saved to {user_local}!"
+    else:
+        return f"FastAPI project '{project_name}' from '{template}' has been deployed directly to {user_local}!"

{fastapi_fastkit-1.1.1 → fastapi_fastkit-1.1.3}/src/fastapi_fastkit/cli.py

@@ -1,3 +1,4 @@
+# TODO : add a feature to automatically fix appropriate fastkit output console size
 # --------------------------------------------------------------------------
 # The Module defines main and core CLI operations for FastAPI-fastkit.
 #
@@ -17,14 +18,16 @@ from rich.panel import Panel
 
 from fastapi_fastkit.backend.main import (
     add_new_route,
+    ask_create_project_folder,
     create_venv_with_manager,
+    deploy_template_with_folder_option,
     find_template_core_modules,
     generate_dependency_file_with_manager,
+    get_deployment_success_message,
     inject_project_metadata,
     install_dependencies_with_manager,
     read_template_stack,
 )
-from fastapi_fastkit.backend.transducer import copy_and_convert_template
 from fastapi_fastkit.core.exceptions import CLIExceptions
 from fastapi_fastkit.core.settings import FastkitConfig
 from fastapi_fastkit.utils.logging import get_logger, setup_logging
@@ -191,6 +194,7 @@ def startdemo(
     """
     Create a new FastAPI project from templates and inject metadata.
     """
+    # TODO : add --template-name option to specify the template name
     settings = ctx.obj["settings"]
 
     template_dir = settings.FASTKIT_TEMPLATE_ROOT
@@ -258,25 +262,27 @@ def startdemo(
         print_error("Project creation aborted!")
         return
 
+    # Ask user whether to create a new project folder
+    create_project_folder = ask_create_project_folder(project_name)
+
     try:
         user_local = settings.USER_WORKSPACE
-        project_dir = os.path.join(user_local, project_name)
-
-        click.echo(f"FastAPI template project will deploy at '{user_local}'")
 
-        copy_and_convert_template(target_template, user_local, project_name)
+        project_dir, _ = deploy_template_with_folder_option(
+            target_template, user_local, project_name, create_project_folder
+        )
 
         inject_project_metadata(
             project_dir, project_name, author, author_email, description
         )
 
-        # Create virtual environment and install dependencies with selected package manager
         venv_path = create_venv_with_manager(project_dir, package_manager)
         install_dependencies_with_manager(project_dir, venv_path, package_manager)
 
-        print_success(
-            f"FastAPI project '{project_name}' from '{template}' has been created and saved to {user_local}!"
+        success_message = get_deployment_success_message(
+            template, project_name, user_local, create_project_folder
         )
+        print_success(success_message)
 
     except Exception as e:
         if settings.DEBUG_MODE:
@@ -323,8 +329,11 @@ def init(
 ) -> None:
     """
     Start a empty FastAPI project setup.
+
     This command will automatically create a new FastAPI project directory and a python virtual environment.
+
     Dependencies will be automatically installed based on the selected stack at venv.
+
     Project metadata will be injected to the project files.
     """
     settings = ctx.obj["settings"]
@@ -402,13 +411,15 @@ def init(
         print_error("Project creation aborted!")
         return
 
+    # Ask user whether to create a new project folder
+    create_project_folder = ask_create_project_folder(project_name)
+
     try:
         user_local = settings.USER_WORKSPACE
-        project_dir = os.path.join(user_local, project_name)
-
-        click.echo(f"FastAPI project will deploy at '{user_local}'")
 
-        copy_and_convert_template(target_template, user_local, project_name)
+        project_dir, _ = deploy_template_with_folder_option(
+            target_template, user_local, project_name, create_project_folder
+        )
 
         inject_project_metadata(
             project_dir, project_name, author, author_email, description
@@ -439,9 +450,10 @@ def init(
         venv_path = create_venv_with_manager(project_dir, package_manager)
         install_dependencies_with_manager(project_dir, venv_path, package_manager)
 
-        print_success(
-            f"FastAPI project '{project_name}' has been created successfully and saved to {user_local}!"
+        success_message = get_deployment_success_message(
+            template, project_name, user_local, create_project_folder
         )
+        print_success(success_message)
 
         print_info(
             "To start your project, run 'fastkit runserver' at newly created FastAPI project directory"
@@ -457,25 +469,43 @@ def init(
 
 
 @fastkit_cli.command()
-@click.argument("project_name")
 @click.argument("route_name")
+@click.argument("project_dir", default=".")
 @click.pass_context
-def addroute(ctx: Context, project_name: str, route_name: str) -> None:
+def addroute(ctx: Context, route_name: str, project_dir: str) -> None:
     """
     Add a new route to the FastAPI project.
+
+    Examples:\n
+        fastkit addroute user .          # Add 'user' route to current directory
+        fastkit addroute user my_project # Add 'user' route to 'my_project' in workspace
     """
     settings = ctx.obj["settings"]
-    user_local = settings.USER_WORKSPACE
-    project_dir = os.path.join(user_local, project_name)
+
+    if project_dir == ".":
+        actual_project_dir = os.getcwd()
+        project_name = os.path.basename(actual_project_dir)
+    else:
+        user_local = settings.USER_WORKSPACE
+        actual_project_dir = os.path.join(user_local, project_dir)
+        project_name = project_dir
 
     # Check if project exists
-    if not os.path.exists(project_dir):
-        print_error(f"Project '{project_name}' does not exist in '{user_local}'.")
+    if not os.path.exists(actual_project_dir):
+        if project_dir == ".":
+            print_error("Current directory is not a valid project directory.")
+        else:
+            print_error(
+                f"Project '{project_dir}' does not exist in '{settings.USER_WORKSPACE}'."
+            )
         return
 
     # Verify it's a fastkit project
-    if not is_fastkit_project(project_dir):
-        print_error(f"'{project_name}' is not a FastAPI-fastkit project.")
+    if not is_fastkit_project(actual_project_dir):
+        if project_dir == ".":
+            print_error("Current directory is not a FastAPI-fastkit project.")
+        else:
+            print_error(f"'{project_dir}' is not a FastAPI-fastkit project.")
         return
 
     # Validate route name
@@ -499,26 +529,34 @@ def addroute(ctx: Context, project_name: str, route_name: str) -> None:
             {
                 "Project": project_name,
                 "Route Name": route_name,
-                "Target Directory": project_dir,
+                "Target Directory": actual_project_dir,
             },
         )
         console.print(table)
 
-        # Confirm before proceeding
-        confirm = click.confirm(
-            f"\nDo you want to add route '{route_name}' to project '{project_name}'?",
-            default=True,
-        )
+        if project_dir == ".":
+            confirm_message = (
+                f"\nDo you want to add route '{route_name}' to the current project?"
+            )
+        else:
+            confirm_message = f"\nDo you want to add route '{route_name}' to project '{project_name}'?"
+
+        confirm = click.confirm(confirm_message, default=True)
         if not confirm:
             print_error("Operation cancelled!")
             return
 
         # Add the new route
-        add_new_route(project_dir, route_name)
+        add_new_route(actual_project_dir, route_name)
 
-        print_success(
-            f"Successfully added new route '{route_name}' to project `{project_name}`"
-        )
+        if project_dir == ".":
+            print_success(
+                f"Successfully added new route '{route_name}' to the current project!"
+            )
+        else:
+            print_success(
+                f"Successfully added new route '{route_name}' to project '{project_name}'!"
+            )
 
     except Exception as e:
         logger = get_logger()

{fastapi_fastkit-1.1.1 → fastapi_fastkit-1.1.3}/src/fastapi_fastkit/fastapi_project_template/fastapi-empty/requirements.txt-tpl

@@ -7,3 +7,4 @@ httpx==0.28.1
 black==25.1.0
 isort==6.0.0
 mypy==1.15.0
+setuptools==80.9.0

{fastapi_fastkit-1.1.1 → fastapi_fastkit-1.1.3}/src/fastapi_fastkit/fastapi_project_template/fastapi-mcp/README.md-tpl

@@ -190,10 +190,12 @@ Once the server is running, visit:
 The application exposes the following tools and endpoints via MCP:
 
 ### MCP-Specific Endpoints
+
 - **mcp_hello**: Simple hello world endpoint (`/mcp-routes/hello`)
 - **mcp_status**: MCP configuration status (`/mcp-routes/status`)
 
 ### API Endpoints via MCP
+
 - **get_items**: List items with pagination
 - **get_item**: Get specific item by ID
 - **create_item**: Create new item (requires auth)
@@ -229,21 +231,19 @@ COPY scripts/ scripts/
 CMD ["uvicorn", "src.main:app", "--host", "0.0.0.0", "--port", "8000"]
 ```
 
-## Contributing
-
-1. Fork the repository
-2. Create a feature branch
-3. Make your changes
-4. Run tests and linting
-5. Submit a pull request
-
-## License
-
-This project is licensed under the MIT License.
-
 ## Support
 
 For support and questions:
 - Create an issue in the repository
 - Check the FastAPI documentation: https://fastapi.tiangolo.com/
 - Check the FastAPI-MCP documentation: https://github.com/tadata-org/fastapi_mcp
+
+# Project Origin
+
+This project was created based on the template from the [FastAPI-fastkit](https://github.com/bnbong/FastAPI-fastkit) project.
+
+The `FastAPI-fastkit` is an open-source project that helps Python and FastAPI beginners quickly set up a FastAPI-based application development environment in a framework-like structure.
+
+### Template Information
+- Template creator: [bnbong](mailto:bbbong9@gmail.com)
+- FastAPI-fastkit project maintainer: [bnbong](mailto:bbbong9@gmail.com)

{fastapi_fastkit-1.1.1 → fastapi_fastkit-1.1.3}/src/fastapi_fastkit/fastapi_project_template/fastapi-psql-orm/Dockerfile-tpl

@@ -2,11 +2,6 @@ FROM python:3.12-slim
 
 WORKDIR /app
 
-RUN apt-get update && \
-    apt-get install -y --no-install-recommends \
-    build-essential \
-    && rm -rf /var/lib/apt/lists/*
-
 COPY requirements.txt .
 COPY setup.py .
 COPY src/ src/

{fastapi_fastkit-1.1.1 → fastapi_fastkit-1.1.3}/src/fastapi_fastkit/fastapi_project_template/fastapi-psql-orm/docker-compose.yml-tpl

@@ -1,5 +1,3 @@
-version: '3'
-
 services:
   db:
     image: postgres:16-alpine

fastapi_fastkit-1.1.3/src/fastapi_fastkit/fastapi_project_template/fastapi-single-module/README.md-tpl

@@ -0,0 +1,37 @@
+# FastAPI Single Module Template
+
+This template provides a minimal FastAPI application that runs with a single `main.py` module.
+
+## Structure
+```
+.
+├── README.md
+├── requirements.txt
+├── pyproject.toml
+├── setup.py
+├── setup.cfg
+├── src/
+│   └── main.py
+└── tests/
+    ├── conftest.py
+    └── test_main.py
+```
+
+## Run
+```bash
+uvicorn src.main:app --reload
+```
+
+## Requirements
+- Python >= 3.9
+- FastAPI, Uvicorn
+
+# Project Origin
+
+This project was created based on the template from the [FastAPI-fastkit](https://github.com/bnbong/FastAPI-fastkit) project.
+
+The `FastAPI-fastkit` is an open-source project that helps Python and FastAPI beginners quickly set up a FastAPI-based application development environment in a framework-like structure.
+
+### Template Information
+- Template creator: [bnbong](mailto:bbbong9@gmail.com)
+- FastAPI-fastkit project maintainer: [bnbong](mailto:bbbong9@gmail.com)

fastapi_fastkit-1.1.3/src/fastapi_fastkit/fastapi_project_template/fastapi-single-module/pyproject.toml-tpl

@@ -0,0 +1,27 @@
+[project]
+name = "<project_name>"
+version = "0.1.0"
+description = "<description>"
+authors = [
+    {name = "<author>", email = "<author_email>"},
+]
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.9"
+dependencies = [
+    "fastapi>=0.115.8",
+    "uvicorn[standard]>=0.34.0",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3.4",
+    "httpx>=0.28.1",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src"]

fastapi_fastkit-1.1.3/src/fastapi_fastkit/fastapi_project_template/fastapi-single-module/requirements.txt-tpl

@@ -0,0 +1,6 @@
+fastapi==0.115.8
+uvicorn[standard]==0.34.0
+pydantic==2.10.6
+pydantic-settings==2.7.1
+pytest==8.3.4
+httpx==0.28.1

fastapi_fastkit-1.1.3/src/fastapi_fastkit/fastapi_project_template/fastapi-single-module/setup.cfg-tpl

@@ -0,0 +1,4 @@
+[tool:pytest]
+pythonpath = src
+testpaths = tests
+python_files = test_*.py

fastapi_fastkit-1.1.3/src/fastapi_fastkit/fastapi_project_template/fastapi-single-module/setup.py-tpl

@@ -0,0 +1,17 @@
+from setuptools import setup
+
+install_requires: list[str] = [
+    "fastapi",
+    "uvicorn",
+]
+
+description = "[FastAPI-fastkit templated] <description>"
+
+setup(
+    name="<project_name>",
+    description=description,
+    author="<author>",
+    author_email=f"<author_email>",
+    packages=["src"],
+    install_requires=install_requires,
+)

fastapi_fastkit-1.1.3/src/fastapi_fastkit/fastapi_project_template/fastapi-single-module/src/main.py-tpl

@@ -0,0 +1,16 @@
+# --------------------------------------------------------------------------
+# Main server application module
+# --------------------------------------------------------------------------
+from fastapi import FastAPI
+
+app = FastAPI(title="<project_name>")
+
+
+@app.get("/")
+async def root() -> dict[str, str]:
+    return {"message": "Hello from FastAPI Single Module!"}
+
+
+@app.get("/health")
+async def health() -> dict[str, str]:
+    return {"status": "healthy"}

fastapi_fastkit-1.1.3/src/fastapi_fastkit/fastapi_project_template/fastapi-single-module/tests/conftest.py-tpl

@@ -0,0 +1,15 @@
+# --------------------------------------------------------------------------
+# pytest runtime configuration module
+# --------------------------------------------------------------------------
+from collections.abc import Generator
+
+import pytest
+from fastapi.testclient import TestClient
+
+from src.main import app
+
+
+@pytest.fixture(scope="module")
+def client() -> Generator[TestClient, None, None]:
+    with TestClient(app) as c:
+        yield c

fastapi_fastkit-1.1.3/src/fastapi_fastkit/fastapi_project_template/fastapi-single-module/tests/test_main.py-tpl

@@ -0,0 +1,16 @@
+# --------------------------------------------------------------------------
+# Main endpoint testcases
+# --------------------------------------------------------------------------
+from fastapi.testclient import TestClient
+
+
+def test_root(client: TestClient) -> None:
+    res = client.get("/")
+    assert res.status_code == 200
+    assert res.json()["message"].startswith("Hello from FastAPI Single Module")
+
+
+def test_health(client: TestClient) -> None:
+    res = client.get("/health")
+    assert res.status_code == 200
+    assert res.json() == {"status": "healthy"}

{fastapi_fastkit-1.1.1 → fastapi_fastkit-1.1.3}/tests/test_backends/test_main.py

@@ -867,3 +867,96 @@ def read_root():
         ):
             with pytest.raises(BackendExceptions, match="Failed to add new route"):
                 add_new_route(project_dir, "test_route")
+
+
+class TestProjectFolderFunctions:
+    """Test cases for project folder creation functions."""
+
+    def test_ask_create_project_folder(self) -> None:
+        """Test ask_create_project_folder function exists and is callable."""
+        from fastapi_fastkit.backend.main import ask_create_project_folder
+
+        # This function uses click.confirm which requires a terminal in real usage
+        # In tests, we verify it exists and is callable
+        assert callable(ask_create_project_folder)
+
+    def test_get_deployment_success_message(self) -> None:
+        """Test get_deployment_success_message function."""
+        from fastapi_fastkit.backend.main import get_deployment_success_message
+
+        # Test with folder creation
+        message_with_folder = get_deployment_success_message(
+            "fastapi-default", "test-project", "/tmp", True
+        )
+        assert "test-project" in message_with_folder
+        assert "fastapi-default" in message_with_folder
+        assert "created and saved" in message_with_folder
+
+        # Test without folder creation
+        message_without_folder = get_deployment_success_message(
+            "fastapi-default", "test-project", "/tmp", False
+        )
+        assert "test-project" in message_without_folder
+        assert "fastapi-default" in message_without_folder
+        assert "deployed directly" in message_without_folder
+
+        # Messages should be different
+        assert message_with_folder != message_without_folder
+
+    @patch("fastapi_fastkit.backend.main.copy_and_convert_template")
+    @patch("click.echo")
+    def test_deploy_template_with_folder_option_create_folder(
+        self, mock_echo: MagicMock, mock_copy_template: MagicMock
+    ) -> None:
+        """Test deploy_template_with_folder_option with folder creation."""
+        from fastapi_fastkit.backend.main import deploy_template_with_folder_option
+
+        # given
+        target_template = "/path/to/template"
+        user_local = "/tmp"  # Use /tmp instead of /user to avoid permission issues
+        project_name = "test-project"
+        create_folder = True
+
+        # when
+        project_dir, deployment_message = deploy_template_with_folder_option(
+            target_template, user_local, project_name, create_folder
+        )
+
+        # then
+        expected_project_dir = "/tmp/test-project"
+        assert project_dir == expected_project_dir
+        assert "test-project" in deployment_message
+        assert "folder" in deployment_message
+
+        # Verify copy_and_convert_template was called with correct params
+        mock_copy_template.assert_called_once_with(
+            target_template, user_local, project_name
+        )
+        mock_echo.assert_called_once()
+
+    @patch("fastapi_fastkit.backend.main.copy_and_convert_template")
+    @patch("click.echo")
+    def test_deploy_template_with_folder_option_no_folder(
+        self, mock_echo: MagicMock, mock_copy_template: MagicMock
+    ) -> None:
+        """Test deploy_template_with_folder_option without folder creation."""
+        from fastapi_fastkit.backend.main import deploy_template_with_folder_option
+
+        # given
+        target_template = "/path/to/template"
+        user_local = "/tmp"  # Use /tmp instead of /user to avoid permission issues
+        project_name = "test-project"
+        create_folder = False
+
+        # when
+        project_dir, deployment_message = deploy_template_with_folder_option(
+            target_template, user_local, project_name, create_folder
+        )
+
+        # then
+        assert project_dir == user_local
+        assert "directly" in deployment_message
+
+        # Verify copy_and_convert_template was called with empty project name
+        mock_copy_template.assert_called_once_with(target_template, user_local, "")
+        mock_echo.assert_called_once()