FastAPI-fastkit 0.1.0__py3-none-any.whl

fastapi_fastkit/fastapi_project_template/PROJECT_README_TEMPLATE.md

@@ -0,0 +1,66 @@
+---
+name: FastAPI template project README format
+about: Project description for users
+
+---
+# {FASTAPI TEMPLATE PROJECT NAME}
+
+> add FastAPI template project description below
+
+(Write here)
+
+## Stack
+
+> fill out application's stack below
+
+- (Write here)
+- FastAPI {version}
+- Python {version}
+- etc...
+
+## Project Tree
+
+> fill out project source tree below
+
+```
+.
+├── README.md
+├── pdm.lock
+├── pyproject.toml
+├── scripts
+│   └── run-server.sh
+├── src
+│   └── sources...
+└── tests
+    ├── __init__.py
+    ├── testcases...
+    └── conftest.py
+```
+
+## Environment settings
+
+> fill out how to setup this project in local below
+
+(Write here)
+
+## {Other Information ...}
+
+> fill out other important information about this project below
+
+(Write here)
+
+# Origin of this project
+
+The source of this project was created based on the template of the [FastAPI-fastkit](https://github.com/bnbong/FastAPI-fastkit) project.
+
+The `FastAPI-fastkit` project is an open-source project that allows users who are new to Python and FastAPI to quickly set up a FastAPI-based application development environment in a framework-like format.
+
+Thank you for your interest in and use of our software.
+
+### Template information
+
+> fill out template project author information below (do not modify opensource owner information)
+> information of creator must include `Email` address
+
+- Template creator : {fill here}
+- FastAPI-fastkit project owner : [bnbong](mailto:bbbong9@gmail.com)

fastapi_fastkit/fastapi_project_template/README.md

@@ -0,0 +1,20 @@
+# About fastapi project templates
+
+Each fastapi demo project in this folder is pasted to the user's local folder with the FastAPI-fastkit replication as the source code is.
+
+For those with experience in developing Django, it is easy to understand that it performs a similar operation to the `$ django-admin start project mysite` cli-operation.
+
+All source codes in demo projects must consist of **`.py-tpl`**, _not_ .py.
+
+## Base structure of FastAPI template project
+
+(manual will be added later)
+(TODO : add description about -> include "FastAPI-fastkit" in setup.py)
+
+## Adding new FastAPI-based template project
+
+Before adding new FastAPI-based template project here, I strongly recommend that you read the
+[SECURITY.md](../SECURITY.md) and [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md) files to understand
+the direction of this project and the precautions for cooperation.
+
+(outlink to CONTRIBUTING.md will be included & manual will be added later)

fastapi_fastkit/fastapi_project_template/fastapi-default/.env.test-tpl

@@ -0,0 +1,3 @@
+# SECRET_KEY for testing (random string)
+SERVER_DOMAIN=localhost
+SECRET_KEY=jhnsavNAjHSMx0YBvL92wbM9K8FJEVDN

fastapi_fastkit/fastapi_project_template/fastapi-default/.gitignore-tpl

@@ -0,0 +1,191 @@
+### venv template
+# Virtualenv
+# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
+.Python
+[Bb]in
+[Ii]nclude
+[Ll]ib
+[Ll]ib64
+[Ll]ocal
+[Ss]cripts
+pyvenv.cfg
+.venv
+pip-selfcheck.json
+
+### dotenv template
+.env
+
+### VirtualEnv template
+# Virtualenv
+# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
+.Python
+[Bb]in
+[Ii]nclude
+[Ll]ib
+[Ll]ib64
+[Ll]ocal
+pyvenv.cfg
+.venv
+pip-selfcheck.json
+
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/

fastapi_fastkit/fastapi_project_template/fastapi-default/README.md-tpl

@@ -0,0 +1,17 @@
+# Simple FastAPI Project
+
+This is a test project using FastAPI. It is a RESTful API server with user management functionality.
+
+## Features
+
+- User Creation, Read, Update, Delete (CRUD) functionality
+- Automatic OpenAPI documentation generation (Swagger UI, ReDoc)
+- Custom exception handling
+- Test environment with mock data
+
+## Stack
+
+- Python 3.11+
+- FastAPI 0.111.1
+- Pydantic 2.8.2
+- pytest 8.2.2

fastapi_fastkit/fastapi_project_template/fastapi-default/main.py-tpl

@@ -0,0 +1,21 @@
+# --------------------------------------------------------------------------
+# Application's main routine
+# --------------------------------------------------------------------------
+from __future__ import annotations
+
+import uvicorn
+
+from src import create_app, init_logger
+from src.core.settings import settings
+
+init_logger(settings)
+
+app = create_app(settings, app_title, app_description)
+
+if __name__ == "__main__":
+    uvicorn.run(
+        "main:app",
+        host=settings.SERVER_DOMAIN,
+        port=settings.SERVER_PORT,
+        reload=True,
+    )

fastapi_fastkit/fastapi_project_template/fastapi-default/requirements.txt-tpl

@@ -0,0 +1,47 @@
+annotated-types==0.7.0
+anyio==4.4.0
+black==24.4.2
+certifi==2024.7.4
+click==8.1.7
+dnspython==2.6.1
+email_validator==2.2.0
+fastapi==0.111.1
+fastapi-cli==0.0.4
+h11==0.14.0
+httpcore==1.0.5
+httptools==0.6.1
+httpx==0.27.0
+idna==3.7
+iniconfig==2.0.0
+Jinja2==3.1.4
+markdown-it-py==3.0.0
+MarkupSafe==2.1.5
+mdurl==0.1.2
+mypy-extensions==1.0.0
+packaging==24.1
+pathspec==0.12.1
+platformdirs==4.2.2
+pluggy==1.5.0
+pydantic==2.8.2
+pydantic-settings==2.3.4
+pydantic_core==2.20.1
+Pygments==2.18.0
+pytest==8.2.2
+pytest-asyncio==0.23.8
+pytest-timeout==2.3.1
+python-dotenv==1.0.1
+python-multipart==0.0.9
+PyYAML==6.0.1
+rich==13.7.1
+setuptools-scm==8.1.0
+shellingham==1.5.4
+sniffio==1.3.1
+starlette==0.37.2
+typer==0.12.3
+typing_extensions==4.12.2
+uvicorn==0.30.1
+uvloop==0.19.0
+watchfiles==0.22.0
+websockets==12.0
+SQLAlchemy==2.0.36
+sqlmodel==0.0.22

fastapi_fastkit/fastapi_project_template/fastapi-default/script/run-server.sh-tpl

@@ -0,0 +1,2 @@
+# run test server
+fastapi dev main.py --reload

fastapi_fastkit/fastapi_project_template/fastapi-default/script/run-test.sh-tpl

@@ -0,0 +1,2 @@
+# run pytest
+poetry run pytest ../test -s -v

fastapi_fastkit/fastapi_project_template/fastapi-default/setup.cfg-tpl

@@ -0,0 +1,13 @@
+[flake8]
+ignore = E501, E305
+
+[isort]
+line_length=100
+virtual_env=venv
+
+[tool:pytest]
+pythonpath = src
+testpaths = test
+python_files = test_*.py
+asyncio_mode = auto
+timeout = 3

fastapi_fastkit/fastapi_project_template/fastapi-default/setup.py-tpl

@@ -0,0 +1,35 @@
+# --------------------------------------------------------------------------
+# module description here
+# --------------------------------------------------------------------------
+from setuptools import setup, find_packages
+
+install_requires = [
+    # Main Application Dependencies
+    "fastapi==0.111.1",
+    "uvicorn==0.30.1",
+    "httpx==0.27.0",
+    "jinja2==3.1.2",
+    # ORM Dependencies
+    "pydantic==2.8.2",
+    "pydantic_core==2.20.1",
+    "pydantic-settings==2.3.4",
+    # Utility Dependencies
+    "starlette==0.37.2",
+    "typing_extensions==4.12.2",
+    "watchfiles==0.22.0",
+    "pytest==8.2.2",
+    "pytest-asyncio==0.23.8",
+    "FastAPI-fastkit",
+]
+
+# IDE will watch this setup config through your project src, and help you to set up your environment
+setup(
+    name="<project_name>",
+    description="<description>",
+    author="<author>",
+    author_email=f"<author_email>",
+    packages=find_packages(where="src"),
+    use_scm_version=True,
+    requires=["python (>=3.11)"],
+    install_requires=install_requires,
+)

fastapi_fastkit/fastapi_project_template/fastapi-default/src/__init__.py-tpl

@@ -0,0 +1,88 @@
+# --------------------------------------------------------------------------
+# The module creates FastAPI Application.
+# --------------------------------------------------------------------------
+from __future__ import annotations
+
+import logging
+
+from fastapi import FastAPI, Request
+from fastapi.responses import JSONResponse, RedirectResponse
+from starlette.middleware.cors import CORSMiddleware
+from contextlib import asynccontextmanager
+from setuptools_scm import get_version
+
+from src.core.settings import settings
+from src.helper.exceptions import InternalException
+from src.helper.logging import init_logger as _init_logger
+from src.helper.global_data import initialize_mock_data
+from src.router import router
+from src.core.settings import AppSettings
+from src.utils.documents import add_description_at_api_tags
+
+try:
+    __version__ = get_version(
+        root="../", relative_to=__file__
+    )  # git version (dev version)
+except LookupError:
+    __version__ = "1.0.0"  # production version
+
+
+logger = logging.getLogger(__name__)
+
+
+def init_logger(app_settings: AppSettings) -> None:
+    _init_logger(f"fastapi-backend@{__version__}", app_settings)
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    try:
+        logger.info("Application startup")
+
+        logger.info("Init mock data at memory")  # you can put mocking data
+        #                                           in your main FastAPI coroutine memory space.
+        initialize_mock_data()
+        yield
+    finally:
+        logger.info("Application shutdown")
+
+
+def create_app(app_settings: AppSettings, app_title: str, app_description: str) -> FastAPI:
+    app = FastAPI(
+        title=f"{app_title}",
+        description=f"{app_description}",
+        version=__version__,
+        lifespan=lifespan,
+        openapi_url="/openapi.json",
+        redoc_url="/redoc",
+    )
+
+    # Apply Middlewares
+    if settings.BACKEND_CORS_ORIGINS:
+        app.add_middleware(
+            CORSMiddleware,
+            allow_origins=[
+                str(origin).strip("/") for origin in settings.BACKEND_CORS_ORIGINS
+            ],
+            allow_credentials=True,
+            allow_methods=["*"],
+            allow_headers=["*"],
+        )
+
+    # Apply Custom Exception Handler
+    @app.exception_handler(InternalException)
+    async def internal_exception_handler(request: Request, exc: InternalException):
+        return JSONResponse(
+            status_code=exc.status,
+            content=exc.to_response(path=str(request.url)).model_dump(),
+        )
+
+    @app.get("/", include_in_schema=False)
+    async def root(request: Request):
+        return RedirectResponse(url="/v1/")
+
+    app.include_router(router)
+
+    add_description_at_api_tags(app)
+
+    return app

fastapi_fastkit/fastapi_project_template/fastapi-default/src/core/settings.py-tpl

@@ -0,0 +1,96 @@
+# --------------------------------------------------------------------------
+# The module configures Backend Application's settings.
+#
+# This module looks up two .env files below:
+# - production environment: .env file
+# - test environment: .env.test
+# --------------------------------------------------------------------------
+from __future__ import annotations
+
+import warnings
+
+from typing import Any, Optional, Annotated, Literal
+from typing_extensions import Self
+
+from pydantic import (
+    Field,
+    AnyUrl,
+    BeforeValidator,
+    model_validator,
+)
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+def parse_cors(v: Any) -> list[str] | str:
+    if isinstance(v, str) and not v.startswith("["):
+        return [i.strip() for i in v.split(",")]
+    elif isinstance(v, list | str):
+        return v
+    raise ValueError(v)
+
+
+class AppSettings(BaseSettings):
+    model_config = SettingsConfigDict(env_file=".env")
+
+    # Application general configuration
+    LOGGING_DEBUG_LEVEL: bool = Field(
+        default=True,
+        description="True: DEBUG mode, False:: INFO mode",
+    )
+    LOG_FILE_PATH: str = Field(
+        default="../../logs/app.log",
+        description="Log file path",
+    )
+    DEBUG_ALLOW_CORS_ALL_ORIGIN: bool = Field(
+        default=True,
+        description="If True, allow origins for CORS requests.",
+    )
+    DEBUG_ALLOW_NON_CERTIFICATED_USER_GET_TOKEN: bool = Field(
+        default=True,
+        description="If True, allow non-cerficiated users to get ESP token.",
+    )
+    BACKEND_CORS_ORIGINS: Annotated[list[AnyUrl] | str, BeforeValidator(parse_cors)] = (
+        []
+    )
+    THREAD_POOL_SIZE: Optional[int] = Field(
+        default=10,
+        description="Change the server's thread pool size to handle non-async function",
+    )
+    ENVIRONMENT: Literal["local", "staging", "production"] = "local"
+    SERVER_DOMAIN: str = Field(
+        default="localhost",
+        description="Domain of server",
+    )
+    SERVER_PORT: int = Field(
+        default=9080,
+        description="Server's port",
+    )
+
+    # Application security configuration
+    SECRET_KEY: str = Field(
+        default="example_secret_key_WoW",
+        description="Secret key to be used for issuing HMAC tokens.",
+    )
+    HASH_ALGORITHM: str = Field(default="HS256", description="Algorithm for Hashing")  # for JWT utility
+    # 60 minutes * 24 hours * 8 days = 8 days
+    ACCESS_TOKEN_EXPIRE_MINUTES: int = 60 * 24 * 8  # for JWT utility
+
+    def _check_default_secret(self, var_name: str, value: str | None) -> None:
+        if value == "example_secret_key_WoW":
+            message = (
+                f'The value of {var_name} is "example_secret_key_WoW", '
+                "for security, please change it, at least for deployments."
+            )
+            if self.ENVIRONMENT == "local":
+                warnings.warn(message, stacklevel=1)
+            else:
+                raise ValueError(message)
+
+    @model_validator(mode="after")
+    def _enforce_non_default_secrets(self) -> Self:
+        self._check_default_secret("SECRET_KEY", self.SECRET_KEY)
+
+        return self
+
+
+settings = AppSettings()