FastAPI-fastkit 0.1.0__tar.gz

fastapi_fastkit-0.1.0/LICENSE

@@ -0,0 +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.

fastapi_fastkit-0.1.0/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.1
+Name: FastAPI-fastkit
+Version: 0.1.0
+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=".github/FastAPI-fastkit_logo/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://img.shields.io/github/v/release/bnbong/FastAPI-fastkit" 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` of the JAVA ecosystem & Python Django's `django-admin` cli operation.
+
+---
+
+(other content will be updated later)
+
+---
+@author bnbong bbbong9@gmail.com

fastapi_fastkit-0.1.0/README.md

@@ -0,0 +1,27 @@
+<p align="center">
+    <img align="top" width="70%" src=".github/FastAPI-fastkit_logo/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://img.shields.io/github/v/release/bnbong/FastAPI-fastkit" 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` of the JAVA ecosystem & Python Django's `django-admin` cli operation.
+
+---
+
+(other content will be updated later)
+
+---
+@author bnbong bbbong9@gmail.com

fastapi_fastkit-0.1.0/pyproject.toml

@@ -0,0 +1,80 @@
+[project]
+name = "FastAPI-fastkit"
+version = "0.1.0"
+description = "Fast, easy-to-use starter kit for new users of Python and FastAPI"
+authors = [
+    { name = "bnbong", email = "bbbong9@gmail.com" },
+]
+dependencies = [
+    "click>=8.1.7",
+    "rich>=13.9.2",
+    "fastapi-cli>=0.0.5",
+]
+requires-python = ">=3.12"
+readme = "README.md"
+
+[project.license]
+text = "MIT"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.3.3",
+    "pytest-cov>=5.0.0",
+    "black>=24.10.0",
+    "pre-commit>=4.0.1",
+    "mypy>=1.12.0",
+    "isort>=5.13.2",
+]
+
+[project.scripts]
+fastkit = "fastapi_fastkit.cli:fastkit_cli"
+
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[tool.pdm]
+distribution = true
+
+[tool.pdm.version]
+source = "file"
+path = "src/fastapi_fastkit/__init__.py"
+
+[tool.pdm.dev-dependencies]
+test = [
+    "pytest>=8.3.3",
+    "pytest-cov>=5.0.0",
+]
+lint = [
+    "black>=24.10.0",
+    "mypy>=1.12.0",
+    "isort>=5.13.2",
+]
+dev = [
+    "pre-commit>=4.0.1",
+]
+
+[tool.pytest.ini_options]
+testpaths = [
+    "test",
+]
+python_files = "test_*.py"
+
+[tool.isort]
+profile = "black"
+
+[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

fastapi_fastkit-0.1.0/src/fastapi_fastkit/__init__.py

@@ -0,0 +1,10 @@
+__version__ = "0.0.1"
+
+import os
+
+from rich.console import Console
+
+if "PYTEST_CURRENT_TEST" in os.environ:
+    console = Console(no_color=True)
+else:
+    console = Console()

fastapi_fastkit-0.1.0/src/fastapi_fastkit/__main__.py

@@ -0,0 +1,8 @@
+# --------------------------------------------------------------------------
+# FastAPI-fastkit package main routine
+#
+# @author bnbong
+# --------------------------------------------------------------------------
+from fastapi_fastkit.cli import fastkit_cli
+
+fastkit_cli()

fastapi_fastkit-0.1.0/src/fastapi_fastkit/backend.py

@@ -0,0 +1,112 @@
+# --------------------------------------------------------------------------
+# The Module defines backend operations for FastAPI-fastkit CLI.
+#
+# @author bnbong bbbong9@gmail.com
+# --------------------------------------------------------------------------
+import os
+import re
+from logging import getLogger
+from typing import Any
+
+import click
+from click.core import Context
+from rich.panel import Panel
+from rich.table import Table
+from rich.text import Text
+
+from fastapi_fastkit.core.exceptions import TemplateExceptions
+
+from . import console
+
+logger = getLogger(__name__)
+
+REGEX = r"\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,7}\b"
+
+
+def print_error(message: str, title: str = "Error") -> None:
+    """Print an error message with specified output style."""
+    error_text = Text()
+    error_text.append("❌ ", style="bold red")
+    error_text.append(message)
+    console.print(Panel(error_text, border_style="red", title=title))
+
+
+def print_success(message: str, title: str = "Success") -> None:
+    """Print a success message with specified output style."""
+    success_text = Text()
+    success_text.append("✨ ", style="bold yellow")
+    success_text.append(message, style="bold green")
+    console.print(Panel(success_text, border_style="green", title=title))
+
+
+def print_warning(message: str, title: str = "Warning") -> None:
+    """Print a warning message with specified output style."""
+    warning_text = Text()
+    warning_text.append("⚠️ ", style="bold yellow")
+    warning_text.append(message)
+    console.print(Panel(warning_text, border_style="yellow", title=title))
+
+
+def create_info_table(
+    title: str, data: dict[str, str], show_header: bool = False
+) -> Table:
+    """Create a table for displaying information."""
+    table = Table(title=title, show_header=show_header, title_style="bold magenta")
+    table.add_column("Field", style="cyan")
+    table.add_column("Value", style="green")
+
+    for key, value in data.items():
+        table.add_row(key, value)
+
+    return table
+
+
+def validate_email(ctx: Context, param: Any, value: Any) -> Any:
+    """Validate email format."""
+    try:
+        if not re.match(REGEX, value):
+            raise ValueError(value)
+        return value
+    except ValueError as e:
+        print_error(f"Incorrect email address given: {e}")
+        value = click.prompt(param.prompt)
+        return validate_email(ctx, param, value)
+
+
+def inject_project_metadata(
+    target_dir: str,
+    project_name: str,
+    author: str,
+    author_email: str,
+    description: str,
+) -> None:
+    """Inject project metadata."""
+    try:
+        main_py_path = os.path.join(target_dir, "main.py")
+        setup_py_path = os.path.join(target_dir, "setup.py")
+
+        with open(main_py_path, "r+") as f:
+            content = f.read()
+            content = content.replace("app_title", f'"{project_name}"')
+            content = content.replace("app_description", f'"{description}"')
+            f.seek(0)
+            f.write(content)
+            f.truncate()
+
+        with open(setup_py_path, "r+") as f:
+            content = f.read()
+            content = content.replace("<project_name>", project_name, 1)
+            content = content.replace("<description>", description, 1)
+            content = content.replace("<author>", author, 1)
+            content = content.replace("<author_email>", author_email, 1)
+            f.seek(0)
+            f.write(content)
+            f.truncate()
+    except Exception as e:
+        print_error(f"Error during metadata injection: {e}")
+        raise TemplateExceptions("Failed to inject metadata")
+
+
+# TODO : modify this function
+# def read_template_stack() -> Union[list, None]:
+#     pass