FastAPI-fastkit 1.0.1__py3-none-any.whl → 1.0.2__py3-none-any.whl

fastapi_fastkit/fastapi_project_template/fastapi-custom-response/.gitignore-tpl

@@ -1,191 +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/
+### 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-custom-response/README.md-tpl

@@ -1,156 +1,156 @@
-# Async Item Management API with Custom Response System
-
-A FastAPI-based REST API demonstrating asynchronous processing and standardized response handling.
-
-## Tech Stack
-
-- Python 3.12+
-- FastAPI + uvicorn
-- Pydantic 2 & pydantic-settings
-- pytest, pytest-asyncio
-- mypy + black + isort
-- aiofiles (async file handling)
-
-## Project Structure
-
-```
-.
-├── src/
-│   ├── core
-│   │   └── config.py
-│   └── api
-│   │   ├── api.py
-│   │   └── routes
-│   │       └── items.py
-│   ├── schemas
-│   │   ├── base.py # Base response schema
-│   │   └── items.py
-│   ├── helper
-│   │   ├── exceptions.py # Exception handlers
-│   │   └── pagination.py # Paginator
-│   ├── crud
-│   │   └── items.py
-│   ├── mocks
-│   │   └── mock_items.json
-│   └── utils
-│       └── documents.py # custom OpenAPI docs generator
-└── 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
-
-### 1. Custom Response System
-- **Standardized Response Format** (`schemas/base.py`):
-  ```python
-  class ResponseSchema(BaseModel, Generic[T]):
-      timestamp: str  # ISO 8601 format
-      status: int     # HTTP status code
-      code: str       # Custom error code
-      path: str       # Request endpoint
-      message: T      # Response payload/error
-  ```
-- **Exception Handling** (`helper/exceptions.py`):
-  - `InternalException` class with error code mapping
-  - Automatic error response formatting
-  - Custom error codes with HTTP status mapping
-
-#### Response Examples
-
-##### Success Response
-
-```json
-{
-    "timestamp": "2024-02-15T09:30:00.000Z",
-    "status": 200,
-    "code": "HTTP-200",
-    "path": "/items/1",
-    "message": {
-        "id": 1,
-        "name": "Test Item 1",
-        "price": 20.0,
-        "category": "test"
-    }
-}
-```
-
-##### Error Response
-
-```json
-{
-    "timestamp": "2024-02-15T09:30:00.000Z",
-    "status": 404,
-    "code": "DATA-002",
-    "path": "/items/999",
-    "message": "ERROR: Item not found"
-}
-```
-
-### 2. Async Operations
-- Asynchronous CRUD operations with aiofiles
-- Non-blocking I/O for JSON data management
-- Async test client with pytest-asyncio
-
-### 3. Enhanced Documentation
-- Custom OpenAPI tags and descriptions (`utils/documents.py`)
-- Automatic API documentation generation
-- Response schema examples in Swagger/ReDoc
-
-## 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:bbbong9@gmail.com)
-- Project maintainer: [bnbong](mailto:bbbong9@gmail.com)
+# Async Item Management API with Custom Response System
+
+A FastAPI-based REST API demonstrating asynchronous processing and standardized response handling.
+
+## Tech Stack
+
+- Python 3.12+
+- FastAPI + uvicorn
+- Pydantic 2 & pydantic-settings
+- pytest, pytest-asyncio
+- mypy + black + isort
+- aiofiles (async file handling)
+
+## Project Structure
+
+```
+.
+├── src/
+│   ├── core
+│   │   └── config.py
+│   └── api
+│   │   ├── api.py
+│   │   └── routes
+│   │       └── items.py
+│   ├── schemas
+│   │   ├── base.py # Base response schema
+│   │   └── items.py
+│   ├── helper
+│   │   ├── exceptions.py # Exception handlers
+│   │   └── pagination.py # Paginator
+│   ├── crud
+│   │   └── items.py
+│   ├── mocks
+│   │   └── mock_items.json
+│   └── utils
+│       └── documents.py # custom OpenAPI docs generator
+└── 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
+
+### 1. Custom Response System
+- **Standardized Response Format** (`schemas/base.py`):
+  ```python
+  class ResponseSchema(BaseModel, Generic[T]):
+      timestamp: str  # ISO 8601 format
+      status: int     # HTTP status code
+      code: str       # Custom error code
+      path: str       # Request endpoint
+      message: T      # Response payload/error
+  ```
+- **Exception Handling** (`helper/exceptions.py`):
+  - `InternalException` class with error code mapping
+  - Automatic error response formatting
+  - Custom error codes with HTTP status mapping
+
+#### Response Examples
+
+##### Success Response
+
+```json
+{
+    "timestamp": "2024-02-15T09:30:00.000Z",
+    "status": 200,
+    "code": "HTTP-200",
+    "path": "/items/1",
+    "message": {
+        "id": 1,
+        "name": "Test Item 1",
+        "price": 20.0,
+        "category": "test"
+    }
+}
+```
+
+##### Error Response
+
+```json
+{
+    "timestamp": "2024-02-15T09:30:00.000Z",
+    "status": 404,
+    "code": "DATA-002",
+    "path": "/items/999",
+    "message": "ERROR: Item not found"
+}
+```
+
+### 2. Async Operations
+- Asynchronous CRUD operations with aiofiles
+- Non-blocking I/O for JSON data management
+- Async test client with pytest-asyncio
+
+### 3. Enhanced Documentation
+- Custom OpenAPI tags and descriptions (`utils/documents.py`)
+- Automatic API documentation generation
+- Response schema examples in Swagger/ReDoc
+
+## 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:bbbong9@gmail.com)
+- Project maintainer: [bnbong](mailto:bbbong9@gmail.com)