[TEMPLATE] add fastapi-dockerized, fastapi-custom-response, fastapi-async-crud template, modified fastapi-default template

Author: bnbong

src/fastapi_fastkit/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.2"
+__version__ = "0.1.3"
 
 import os
 

src/fastapi_fastkit/fastapi_project_template/fastapi-async-crud/.env-tpl

@@ -0,0 +1 @@
+SECRET_KEY=changethis

src/fastapi_fastkit/fastapi_project_template/fastapi-async-crud/.env.test-tpl

@@ -1,191 +1,30 @@
-### 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
+.idea
 .ipynb_checkpoints
+.mypy_cache
+.vscode
+__pycache__
+.pytest_cache
+htmlcov
+dist
+site
+.coverage*
+coverage.xml
+.netlify
+test.db
+log.txt
+Pipfile.lock
+env3.*
+env
+docs_build
+site_build
+venv
+docs.zip
+archive.zip
+
+# vim temporary files
+*~
+.*.sw?
+.cache
 
-# 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/
+# macOS
+.DS_Store

src/fastapi_fastkit/fastapi_project_template/fastapi-async-crud/.gitignore-tpl

@@ -1,17 +1,107 @@
-# Simple FastAPI Project
+# Async Item Management API Server
 
-This is a test project using FastAPI. It is a RESTful API server with user management functionality.
+A FastAPI-based item management API implemented with asynchronous processing.
 
-## Features
+## Tech Stack
 
-- User Creation, Read, Update, Delete (CRUD) functionality
-- Automatic OpenAPI documentation generation (Swagger UI, ReDoc)
-- Custom exception handling
-- Test environment with mock data
+- Python 3.12+
+- FastAPI + uvicorn
+- Pydantic 2 & pydantic-settings
+- pytest, pytest-asyncio
+- mypy + black + isort
+- aiofiles (async file handling)
 
-## Stack
+## Project Structure
 
-- Python 3.11+
-- FastAPI 0.111.1
-- Pydantic 2.8.2
-- pytest 8.2.2
+```
+.
+├── README.md
+├── requirements.txt
+├── setup.py
+├── scripts
+│   └── run-server.sh
+├── src
+│   ├── main.py
+│   ├── schemas
+│   │   └── items.py
+│   ├── mocks
+│   │   └── mock_items.json
+│   ├── crud
+│   │   └── items.py
+│   ├── core
+│   │   └── config.py
+│   └── api
+│       ├── api.py
+│       └── routes
+│           └── items.py
+└── tests
+    ├── __init__.py
+    ├── test_items.py
+    └── conftest.py
+```
+
+## How to Run
+
+Run in virtual environment:
+
+```bash
+# Install dependencies
+$ pip install -r requirements.txt
+
+# Start development server (using script)
+$ bash scripts/run-server.sh
+
+# Manual run
+$ uvicorn src.main:app --reload
+```
+
+Access API documentation after server starts:
+
+```bash
+<domain:port>/docs  # Swagger format
+<domain:port>/redoc  # ReDoc format
+
+# example
+http://127.0.0.1:8000/docs
+```
+
+## API Endpoints
+
+| Method | Endpoint         | Description                |
+|--------|------------------|----------------------------|
+| GET    | `/items/`        | List all items             |
+| GET    | `/items/{id}`    | Get single item            |
+| POST   | `/items/`        | Create new item            |
+| PUT    | `/items/{id}`    | Update existing item       |
+| DELETE | `/items/{id}`    | Delete item                |
+
+## Key Features
+
+- Async file I/O operations using aiofiles
+- Mock data initialization
+- Pydantic model validation
+- CRUD operations implementation
+- Integrated test cases
+- In-memory JSON database for development
+
+## Running Tests
+
+```bash
+# Run all tests
+$ pytest tests/
+
+# Run specific test file
+$ pytest tests/test_items.py -v
+```
+
+For FastAPI documentation: <https://fastapi.tiangolo.com/>
+
+## Project Origin
+
+This project was created using the [FastAPI-fastkit](https://github.com/bnbong/FastAPI-fastkit) template.
+
+FastAPI-fastkit is an open-source project that helps developers quickly set up FastAPI-based applications with proper structure and tooling.
+
+### Template Information
+- Template author: [bnbong](mailto:[email protected])
+- Project maintainer: [bnbong](mailto:[email protected])