FastAPI-fastkit 0.1.0__tar.gz → 0.1.1__tar.gz

{fastapi_fastkit-0.1.0 → fastapi_fastkit-0.1.1}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 이준혁
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 이준혁
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fastapi_fastkit-0.1.1/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.1
+Name: FastAPI-fastkit
+Version: 0.1.1
+Summary: Fast, easy-to-use starter kit for new users of Python and FastAPI
+Author-Email: bnbong <bbbong9@gmail.com>
+License: MIT
+Requires-Python: >=3.12
+Requires-Dist: click>=8.1.7
+Requires-Dist: rich>=13.9.2
+Requires-Dist: fastapi-cli>=0.0.5
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.3; extra == "dev"
+Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
+Requires-Dist: black>=24.10.0; extra == "dev"
+Requires-Dist: pre-commit>=4.0.1; extra == "dev"
+Requires-Dist: mypy>=1.12.0; extra == "dev"
+Requires-Dist: isort>=5.13.2; extra == "dev"
+Description-Content-Type: text/markdown
+
+<p align="center">
+    <img align="top" width="70%" src="https://bnbong.github.io/projects/img/fastkit_general_logo.png" alt="FastAPI-fastkit"/>
+</p>
+<p align="center">
+<em><b>FastAPI-fastkit</b>: Fast, easy-to-use starter kit for new users of Python and FastAPI</em>
+</p>
+<p align="center">
+<a href="https://pypi.org/project/fastapi-fastkit" target="_blank">
+    <img src="https://img.shields.io/pypi/v/fastapi-fastkit" alt="PyPI - Version">
+</a>
+<a href="https://github.com/bnbong/FastAPI-fastkit/releases" target="_blank">
+    <img src="https://img.shields.io/github/v/release/bnbong/FastAPI-fastkit" alt="GitHub Release">
+</a>
+</p>
+
+---
+
+This project was created to speed up the configuration of the development environment needed to develop Python-based web apps for new users of Python and [FastAPI](https://github.com/fastapi/fastapi).
+
+This project was inspired by the `SpringBoot initializer` & Python Django's `django-admin` cli operation.
+
+## Key Features
+
+- **Immediate FastAPI project creation** : Super-fast FastAPI workspace & project creation via CLI, inspired by `django-admin`feature of [Python Django](https://github.com/django/django)
+- **Prettier CLI outputs** : beautiful CLI experiment ([rich library](https://github.com/Textualize/rich) feature)
+- **Standards-based FastAPI project template** : All FastAPI-fastkit templates are based on Python standards and FastAPI's common use
+
+## Installation
+
+Install `FastAPI-fastkit` at your Python environment.
+
+```console
+$ pip install FastAPI-fastkit
+
+---> 100%
+```
+
+## Usage
+
+### Create a new FastAPI project workspace environment immediately
+
+Create a new FastAPI project workspace with:
+
+```console
+$ fastkit startproject
+Enter project name: <your-project-name>
+
+Available Stacks and Dependencies:
+      MINIMAL Stack
+┌──────────────┬─────────┐
+│ Dependency 1 │ fastapi │
+│ Dependency 2 │ uvicorn │
+└──────────────┴─────────┘
+
+
+       STANDARD Stack
+┌──────────────┬────────────┐
+│ Dependency 1 │ fastapi    │
+│ Dependency 2 │ uvicorn    │
+│ Dependency 3 │ sqlalchemy │
+│ Dependency 4 │ alembic    │
+│ Dependency 5 │ pytest     │
+└──────────────┴────────────┘
+
+
+           FULL Stack
+┌──────────────┬────────────────┐
+│ Dependency 1 │ fastapi        │
+│ Dependency 2 │ uvicorn        │
+│ Dependency 3 │ sqlalchemy     │
+│ Dependency 4 │ alembic        │
+│ Dependency 5 │ pytest         │
+│ Dependency 6 │ redis          │
+│ Dependency 7 │ celery         │
+│ Dependency 8 │ docker-compose │
+└──────────────┴────────────────┘
+
+
+Select stack (minimal, standard, full): minimal
+  Creating Project:
+ new-fastapi-project
+┌───────────┬────────┐
+│ Component │ Status │
+│ fastapi   │ ✓      │
+│ uvicorn   │ ✓      │
+└───────────┴────────┘
+Creating virtual environment...
+Installing dependencies...
+⠙ Setting up project environment...Collecting <packages~>
+
+---> 100%
+
+╭─────────────────────────────────────────────────────────────────── Success ────────────────────────────────────────────────────────────────────╮
+│ ✨ Project '<your-project-name>' has been created successfully!                                                                                │
+╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭───────────────────────────────────────────────────────────────────── Info ─────────────────────────────────────────────────────────────────────╮
+│ ℹ To activate the virtual environment, run:                                                                                                    │
+│                                                                                                                                                │
+│     source /<new-venv-path>/venv/bin/activate                                                                                                  │
+╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+This command will create a new FastAPI project workspace environment with Python virtual environment.
+
+### Place a structured FastAPI project immediately
+
+Place a structured FastAPI project immediately with:
+
+```console
+$ fastkit startup
+Enter the project name: <your-project-name>
+Enter the author name: <your-name>
+Enter the author email: <your-email>
+Enter the project description: <your-project-description>
+Deploying FastAPI project using 'fastapi-default' template
+Template path:
+/<fastapi_fastkit-package-path>/fastapi_project_template/fastapi-defau
+lt
+
+
+                    Project Information
+┌──────────────┬──────────────────────────────────────────┐
+│ Project Name │ <your-project-name>                      │
+│ Author       │ <your-name>                              │
+│ Author Email │ <your-email>                             │
+│ Description  │ <your-project-description>               │
+└──────────────┴──────────────────────────────────────────┘
+
+Do you want to proceed with project creation? [y/N]: y
+FastAPI template project will deploy at '<your-project-path>'
+
+---> 100%
+
+╭─────────────────────────────────────────────────────────────────── Success ────────────────────────────────────────────────────────────────────╮
+│ ✨ FastAPI project '<your-project-name>' from 'fastapi-default' has been created and saved to                                                  │
+│ <your-project-path>!                                                                                                                           │
+╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+## Significance of FastAPI-fastkit
+
+FastAPI-fastkit aims to provide a fast and easy-to-use starter kit for new users of Python and FastAPI.
+
+This idea was initiated with the aim of full fill to help FastAPI newcomers to learn from the beginning, which is the production significance of the FastAPI-cli package added with the [FastAPI 0.111.0 version update](https://github.com/fastapi/fastapi/releases/tag/0.111.0).
+
+As one person who has been using and loving FastAPI for a long time, I wanted to develop a project that could help me a little bit to practice [the wonderful motivation](https://github.com/fastapi/fastapi/pull/11522#issuecomment-2264639417) that FastAPI developer [tiangolo](https://github.com/tiangolo) has.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+@author bnbong bbbong9@gmail.com

fastapi_fastkit-0.1.1/README.md

@@ -0,0 +1,154 @@
+<p align="center">
+    <img align="top" width="70%" src="https://bnbong.github.io/projects/img/fastkit_general_logo.png" alt="FastAPI-fastkit"/>
+</p>
+<p align="center">
+<em><b>FastAPI-fastkit</b>: Fast, easy-to-use starter kit for new users of Python and FastAPI</em>
+</p>
+<p align="center">
+<a href="https://pypi.org/project/fastapi-fastkit" target="_blank">
+    <img src="https://img.shields.io/pypi/v/fastapi-fastkit" alt="PyPI - Version">
+</a>
+<a href="https://github.com/bnbong/FastAPI-fastkit/releases" target="_blank">
+    <img src="https://img.shields.io/github/v/release/bnbong/FastAPI-fastkit" alt="GitHub Release">
+</a>
+</p>
+
+---
+
+This project was created to speed up the configuration of the development environment needed to develop Python-based web apps for new users of Python and [FastAPI](https://github.com/fastapi/fastapi).
+
+This project was inspired by the `SpringBoot initializer` & Python Django's `django-admin` cli operation.
+
+## Key Features
+
+- **Immediate FastAPI project creation** : Super-fast FastAPI workspace & project creation via CLI, inspired by `django-admin`feature of [Python Django](https://github.com/django/django)
+- **Prettier CLI outputs** : beautiful CLI experiment ([rich library](https://github.com/Textualize/rich) feature)
+- **Standards-based FastAPI project template** : All FastAPI-fastkit templates are based on Python standards and FastAPI's common use
+
+## Installation
+
+Install `FastAPI-fastkit` at your Python environment.
+
+```console
+$ pip install FastAPI-fastkit
+
+---> 100%
+```
+
+## Usage
+
+### Create a new FastAPI project workspace environment immediately
+
+Create a new FastAPI project workspace with:
+
+```console
+$ fastkit startproject
+Enter project name: <your-project-name>
+
+Available Stacks and Dependencies:
+      MINIMAL Stack
+┌──────────────┬─────────┐
+│ Dependency 1 │ fastapi │
+│ Dependency 2 │ uvicorn │
+└──────────────┴─────────┘
+
+
+       STANDARD Stack
+┌──────────────┬────────────┐
+│ Dependency 1 │ fastapi    │
+│ Dependency 2 │ uvicorn    │
+│ Dependency 3 │ sqlalchemy │
+│ Dependency 4 │ alembic    │
+│ Dependency 5 │ pytest     │
+└──────────────┴────────────┘
+
+
+           FULL Stack
+┌──────────────┬────────────────┐
+│ Dependency 1 │ fastapi        │
+│ Dependency 2 │ uvicorn        │
+│ Dependency 3 │ sqlalchemy     │
+│ Dependency 4 │ alembic        │
+│ Dependency 5 │ pytest         │
+│ Dependency 6 │ redis          │
+│ Dependency 7 │ celery         │
+│ Dependency 8 │ docker-compose │
+└──────────────┴────────────────┘
+
+
+Select stack (minimal, standard, full): minimal
+  Creating Project:
+ new-fastapi-project
+┌───────────┬────────┐
+│ Component │ Status │
+│ fastapi   │ ✓      │
+│ uvicorn   │ ✓      │
+└───────────┴────────┘
+Creating virtual environment...
+Installing dependencies...
+⠙ Setting up project environment...Collecting <packages~>
+
+---> 100%
+
+╭─────────────────────────────────────────────────────────────────── Success ────────────────────────────────────────────────────────────────────╮
+│ ✨ Project '<your-project-name>' has been created successfully!                                                                                │
+╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭───────────────────────────────────────────────────────────────────── Info ─────────────────────────────────────────────────────────────────────╮
+│ ℹ To activate the virtual environment, run:                                                                                                    │
+│                                                                                                                                                │
+│     source /<new-venv-path>/venv/bin/activate                                                                                                  │
+╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+This command will create a new FastAPI project workspace environment with Python virtual environment.
+
+### Place a structured FastAPI project immediately
+
+Place a structured FastAPI project immediately with:
+
+```console
+$ fastkit startup
+Enter the project name: <your-project-name>
+Enter the author name: <your-name>
+Enter the author email: <your-email>
+Enter the project description: <your-project-description>
+Deploying FastAPI project using 'fastapi-default' template
+Template path:
+/<fastapi_fastkit-package-path>/fastapi_project_template/fastapi-defau
+lt
+
+
+                    Project Information
+┌──────────────┬──────────────────────────────────────────┐
+│ Project Name │ <your-project-name>                      │
+│ Author       │ <your-name>                              │
+│ Author Email │ <your-email>                             │
+│ Description  │ <your-project-description>               │
+└──────────────┴──────────────────────────────────────────┘
+
+Do you want to proceed with project creation? [y/N]: y
+FastAPI template project will deploy at '<your-project-path>'
+
+---> 100%
+
+╭─────────────────────────────────────────────────────────────────── Success ────────────────────────────────────────────────────────────────────╮
+│ ✨ FastAPI project '<your-project-name>' from 'fastapi-default' has been created and saved to                                                  │
+│ <your-project-path>!                                                                                                                           │
+╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+## Significance of FastAPI-fastkit
+
+FastAPI-fastkit aims to provide a fast and easy-to-use starter kit for new users of Python and FastAPI.
+
+This idea was initiated with the aim of full fill to help FastAPI newcomers to learn from the beginning, which is the production significance of the FastAPI-cli package added with the [FastAPI 0.111.0 version update](https://github.com/fastapi/fastapi/releases/tag/0.111.0).
+
+As one person who has been using and loving FastAPI for a long time, I wanted to develop a project that could help me a little bit to practice [the wonderful motivation](https://github.com/fastapi/fastapi/pull/11522#issuecomment-2264639417) that FastAPI developer [tiangolo](https://github.com/tiangolo) has.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+@author bnbong bbbong9@gmail.com

{fastapi_fastkit-0.1.0 → fastapi_fastkit-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "FastAPI-fastkit"
-version = "0.1.0"
+version = "0.1.1"
 description = "Fast, easy-to-use starter kit for new users of Python and FastAPI"
 authors = [
     { name = "bnbong", email = "bbbong9@gmail.com" },

fastapi_fastkit-0.1.1/src/fastapi_fastkit/__init__.py

@@ -0,0 +1 @@
+__version__ = 'v0.1.1'

fastapi_fastkit-0.1.1/src/fastapi_fastkit/backend/inspector.py

@@ -0,0 +1,203 @@
+# --------------------------------------------------------------------------
+# The Module inspect FastAPI template is appropriate
+#
+# This module will be read by Github Action when contributor
+#   makes a PR of adding new FastAPI template.
+#
+# First, check a FastAPI template is formed a valid template form with .py-tpl extension
+#   & dependencies requirements.
+# Second, check a FastAPI template has a proper FastAPI server implementation.
+#   main.py module must have a FastAPI app creation. like `app = FastAPI()`
+# Third, check a FastAPI template has passed all the tests.
+#
+# This module create temporary named 'temp' directory at src/fastapi_fastkit/backend
+#   and copy a template to Funtional FastAPI application into the temp directory.
+# After the inspection, it will be deleted.
+#
+# This module include virtual environment creation & installation of dependencies.
+# Depending on the volume in which the template is implemented and the number of dependencies,
+#   it may take some time to complete the inspection.
+#
+# @author bnbong
+# --------------------------------------------------------------------------
+import os
+import shutil
+import subprocess
+import sys
+from pathlib import Path
+from typing import Any, Dict, List
+
+from fastapi_fastkit.backend.main import (
+    create_venv,
+    find_template_core_modules,
+    install_dependencies,
+)
+from fastapi_fastkit.backend.transducer import copy_and_convert_template
+from fastapi_fastkit.utils.main import print_error, print_success, print_warning
+
+
+class TemplateInspector:
+    def __init__(self, template_path: str):
+        self.template_path = Path(template_path)
+        self.errors: List[str] = []
+        self.warnings: List[str] = []
+        self.temp_dir = os.path.join(os.path.dirname(__file__), "temp")
+
+        # Create temp directory and copy template
+        os.makedirs(self.temp_dir, exist_ok=True)
+        copy_and_convert_template(str(self.template_path), self.temp_dir)
+
+    def __del__(self) -> None:
+        """Cleanup temp directory when inspector is destroyed."""
+        if os.path.exists(self.temp_dir):
+            shutil.rmtree(self.temp_dir)
+
+    def inspect_template(self) -> bool:
+        """Inspect the template is valid FastAPI application."""
+        checks = [
+            self._check_file_structure,
+            self._check_file_extensions,
+            self._check_dependencies,
+            self._check_fastapi_implementation,
+            self._test_template,
+        ]
+
+        for check in checks:
+            if not check():
+                return False
+        return True
+
+    def _check_file_structure(self) -> bool:
+        """Check the required file and directory structure."""
+        required_paths = [
+            "tests",
+            "requirements.txt-tpl",
+            "setup.py-tpl",
+            "README.md-tpl",
+        ]
+
+        for path in required_paths:
+            if not (self.template_path / path).exists():
+                self.errors.append(f"Missing required path: {path}")
+                return False
+        return True
+
+    def _check_file_extensions(self) -> bool:
+        """Check all Python files have .py-tpl extension."""
+        for path in self.template_path.rglob("*"):
+            if path.is_file() and path.suffix == ".py":
+                self.errors.append(f"Found .py file instead of .py-tpl: {path}")
+                return False
+        return True
+
+    def _check_dependencies(self) -> bool:
+        """Check the dependencies in both setup.py-tpl and requirements.txt-tpl."""
+        req_path = self.template_path / "requirements.txt-tpl"
+        setup_path = self.template_path / "setup.py-tpl"
+
+        if not req_path.exists():
+            self.errors.append("requirements.txt-tpl not found")
+            return False
+        if not setup_path.exists():
+            self.errors.append("setup.py-tpl not found")
+            return False
+
+        with open(req_path) as f:
+            deps = f.read().splitlines()
+            package_names = [dep.split("==")[0] for dep in deps if dep]
+            if "fastapi" not in package_names:
+                self.errors.append(
+                    "FastAPI dependency not found in requirements.txt-tpl"
+                )
+                return False
+        return True
+
+    def _check_fastapi_implementation(self) -> bool:
+        """Check if the template has a proper FastAPI server implementation."""
+        core_modules = find_template_core_modules(self.temp_dir)
+
+        if not core_modules["main"]:
+            self.errors.append("main.py not found in template")
+            return False
+
+        with open(core_modules["main"]) as f:
+            content = f.read()
+            if "FastAPI" not in content or "app" not in content:
+                self.errors.append("FastAPI app creation not found in main.py")
+                return False
+        return True
+
+    def _test_template(self) -> bool:
+        """Run the tests in the converted template directory."""
+        test_dir = Path(self.temp_dir) / "tests"
+        if not test_dir.exists():
+            self.errors.append("Tests directory not found")
+            return False
+
+        try:
+            # Create virtual environment
+            venv_path = create_venv(self.temp_dir)
+
+            # Install dependencies
+            install_dependencies(self.temp_dir, venv_path)
+
+            # Run tests using the venv's pytest
+            if os.name == "nt":  # Windows
+                pytest_path = os.path.join(venv_path, "Scripts", "pytest")
+            else:  # Linux/Mac
+                pytest_path = os.path.join(venv_path, "bin", "pytest")
+
+            result = subprocess.run(
+                [pytest_path, str(test_dir)],
+                capture_output=True,
+                text=True,
+                cwd=self.temp_dir,
+            )
+
+            if result.returncode != 0:
+                self.errors.append(f"Tests failed: {result.stderr}")
+                return False
+
+        except Exception as e:
+            self.errors.append(f"Error running tests: {e}")
+            return False
+
+        return True
+
+
+def inspect_template(template_path: str) -> Dict[str, Any]:
+    """Run the template inspection and return the result."""
+    inspector = TemplateInspector(template_path)
+    is_valid = inspector.inspect_template()
+    result: dict[str, Any] = {
+        "valid": is_valid,
+        "errors": inspector.errors,
+        "warnings": inspector.warnings,
+    }
+
+    if result["valid"]:
+        print_success("Template inspection passed successfully! ✨")
+    elif result["errors"]:
+        error_messages = [str(error) for error in result["errors"]]
+        print_error(
+            "Template inspection failed with following errors:\n"
+            + "\n".join(f"- {error}" for error in error_messages)
+        )
+
+    if result["warnings"]:
+        warning_messages = [str(warning) for warning in result["warnings"]]
+        print_warning(
+            "Template has following warnings:\n"
+            + "\n".join(f"- {warning}" for warning in warning_messages)
+        )
+
+    return result
+
+
+if __name__ == "__main__":
+    if len(sys.argv) != 2:
+        print("Usage: python inspector.py <template_dir>")
+        sys.exit(1)
+
+    template_dir = sys.argv[1]
+    inspect_template(template_dir)