fastapi-factory-utilities 0.1.0__tar.gz

fastapi_factory_utilities-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 VANROYE Victorien
+
+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_factory_utilities-0.1.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.1
+Name: fastapi_factory_utilities
+Version: 0.1.0
+Summary: Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Httpx, AioPika and OpenTelemetry.
+Home-page: https://github.com/miragecentury/fastapi_factory_utilities
+License: MIT
+Keywords: python,fastapi,beanie,httpx,opentelemetry,microservices
+Author: miragecentury
+Author-email: victorien.vanroye@gmail.com
+Maintainer: miragecentury
+Maintainer-email: victorien.vanroye@gmail.com
+Requires-Python: >=3.12,<3.13
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: beanie (>=1.27.0,<2.0.0)
+Requires-Dist: fastapi (>=0.115.4,<0.116.0)
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Requires-Dist: opentelemetry-exporter-otlp-proto-http (>=1.26.0,<2.0.0)
+Requires-Dist: opentelemetry-instrumentation-fastapi (>=0.49b1,<0.50)
+Requires-Dist: opentelemetry-instrumentation-pymongo (>=0.49b2,<0.50)
+Requires-Dist: opentelemetry-propagator-b3 (>=1.26.0,<2.0.0)
+Requires-Dist: opentelemetry-sdk (>=1.26.0,<2.0.0)
+Requires-Dist: pydantic (>=2.8.2,<3.0.0)
+Requires-Dist: pymongo (>=4.9.2,<4.10.0)
+Requires-Dist: structlog (>=24.1.0,<25.0.0)
+Requires-Dist: typer (>=0.15.1,<0.16.0)
+Requires-Dist: uvicorn (>=0.32.0,<0.33.0)
+Project-URL: Repository, https://github.com/miragecentury/fastapi_factory_utilities
+Description-Content-Type: text/markdown
+
+# fastapi_factory_utilities
+
+Project Empty for Python with Poetry
+
+## Setup
+
+### Dev Tools
+
+#### Python
+
+<https://www.python.org/downloads/>
+
+```bash
+sudo apt install software-properties-common -y
+sudo add-apt-repository ppa:deadsnakes/ppa
+sudo apt update
+sudo apt install python3.12 -y
+```
+
+#### Poetry
+
+<https://python-poetry.org/>
+
+```bash
+curl -sSL https://install.python-poetry.org | python3.12 -
+```
+
+#### Pre-commit
+
+Included in the project while in virtual environment
+<https://pre-commit.com/>
+
+#### Docker
+
+<https://docs.docker.com/get-docker/>
+
+#### Skaffold
+
+<https://skaffold.dev>
+
+```bash
+curl -Lo skaffold https://storage.googleapis.com/skaffold/releases/latest/skaffold-linux-amd64
+chmod +x skaffold
+sudo mv skaffold /usr/local/bin
+```
+
+#### Buildpacks
+
+<https://buildpacks.io/>
+
+```bash
+sudo add-apt-repository ppa:cncf-buildpacks/pack-cli
+sudo apt-get update
+sudo apt-get install pack-cli
+```
+
+#### Paketo
+
+Included with the usage of buildpacks
+<https://paketo.io/>
+
+#### Portman
+
+```bash
+npm install -g @apideck/portman
+```
+
+### MongoDB
+
+<https://docs.mongodb.com/manual/installation/>
+
+```bash
+sudo apt install -y mongodb
+```
+
+### 1- Dev Environment
+
+```bash
+# Initialize python virtual environment and install dependencies
+./scripts/setup_dev_env.sh
+
+pre-commit run --all-files
+```
+
+### 2- Build and Run Application on Docker
+
+```bash
+./scripts/dev-in-container.sh
+```
+
+```bash
+./scripts/test_portman.sh
+```
+

fastapi_factory_utilities-0.1.0/README.md

@@ -0,0 +1,93 @@
+# fastapi_factory_utilities
+
+Project Empty for Python with Poetry
+
+## Setup
+
+### Dev Tools
+
+#### Python
+
+<https://www.python.org/downloads/>
+
+```bash
+sudo apt install software-properties-common -y
+sudo add-apt-repository ppa:deadsnakes/ppa
+sudo apt update
+sudo apt install python3.12 -y
+```
+
+#### Poetry
+
+<https://python-poetry.org/>
+
+```bash
+curl -sSL https://install.python-poetry.org | python3.12 -
+```
+
+#### Pre-commit
+
+Included in the project while in virtual environment
+<https://pre-commit.com/>
+
+#### Docker
+
+<https://docs.docker.com/get-docker/>
+
+#### Skaffold
+
+<https://skaffold.dev>
+
+```bash
+curl -Lo skaffold https://storage.googleapis.com/skaffold/releases/latest/skaffold-linux-amd64
+chmod +x skaffold
+sudo mv skaffold /usr/local/bin
+```
+
+#### Buildpacks
+
+<https://buildpacks.io/>
+
+```bash
+sudo add-apt-repository ppa:cncf-buildpacks/pack-cli
+sudo apt-get update
+sudo apt-get install pack-cli
+```
+
+#### Paketo
+
+Included with the usage of buildpacks
+<https://paketo.io/>
+
+#### Portman
+
+```bash
+npm install -g @apideck/portman
+```
+
+### MongoDB
+
+<https://docs.mongodb.com/manual/installation/>
+
+```bash
+sudo apt install -y mongodb
+```
+
+### 1- Dev Environment
+
+```bash
+# Initialize python virtual environment and install dependencies
+./scripts/setup_dev_env.sh
+
+pre-commit run --all-files
+```
+
+### 2- Build and Run Application on Docker
+
+```bash
+./scripts/dev-in-container.sh
+```
+
+```bash
+./scripts/test_portman.sh
+```

fastapi_factory_utilities-0.1.0/pyproject.toml

@@ -0,0 +1,133 @@
+[tool.poetry]
+name = "fastapi_factory_utilities"
+homepage = "https://github.com/miragecentury/fastapi_factory_utilities"
+repository = "https://github.com/miragecentury/fastapi_factory_utilities"
+keywords = ["python", "fastapi", "beanie", "httpx", "opentelemetry", "microservices"]
+version = "0.1.0"
+description = "Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Httpx, AioPika and OpenTelemetry."
+authors = ["miragecentury <victorien.vanroye@gmail.com>"]
+maintainers = ["miragecentury <victorien.vanroye@gmail.com>"]
+license = "MIT"
+readme = "README.md"
+packages = [
+    { include = "fastapi_factory_utilities", from = "src" },
+]
+classifiers = [
+    "Programming Language :: Python :: 3.12",
+    "Development Status :: 3 - Alpha",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+]
+
+[tool.poetry.dependencies]
+python = "~3.12"
+structlog = "^24.1.0"
+typer = "^0.15.1"
+pydantic = "^2.8.2"
+fastapi = "^0.115.4"
+uvicorn = "^0.32.0"
+opentelemetry-sdk = "^1.26.0"
+opentelemetry-exporter-otlp-proto-http = "^1.26.0"
+httpx = "^0.28.1"
+opentelemetry-instrumentation-fastapi = "^0.49b1"
+opentelemetry-propagator-b3 = "^1.26.0"
+beanie = "^1.27.0"
+opentelemetry-instrumentation-pymongo = "^0.49b2"
+pymongo = "~4.9.2" # version fixed to fix integration between beanie and pytest-mongo
+
+[tool.poetry.group.test]
+optional = true
+
+[tool.poetry.group.test.dependencies]
+mypy = "^1.10.0"
+types-requests = "^2.32.0.20240712"
+types-pyyaml = "^6.0.12.20240311"
+pylint = {version="^3.2.2", extras=["spelling"]}
+black = "^24.4.2"
+pre-commit = "^4.0.1"
+pyupgrade = "^3.15.2"
+pytest = "^8.2.0"
+pytest-xdist = "^3.6.1"
+pytest-cov = "^6.0.0"
+ruff = "^0.7.2"
+pytest-asyncio = "^0.25.0"
+pytest-mongo = "^3.1.0"
+locust = "^2.32.4"
+testcontainers = { version="^4.9.0", extras=["mongodb"] }
+types-deprecated = "^1.2.15.20241117"
+types-pygments = "^2.18.0.20240506"
+types-colorama = "^0.4.15.20240311"
+types-protobuf = "^5.29.1.20241207"
+types-psutil = "^6.1.0.20241221"
+types-pyopenssl = "^24.1.0.20240722"
+types-ujson = "^5.10.0.20240515"
+
+[tool.poetry.extras]
+
+[tool.poetry.scripts]
+fastapi_factory_utilities-example = "fastapi_factory_utilities.example.__main__:main"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+addopts = "tests/units tests/integrations -n auto --color=yes --import-mode=importlib"
+filterwarnings = [
+    "ignore:.*Type google._upb._message.MessageMapContainer:DeprecationWarning",
+    "ignore:.*Type google._upb._message.ScalarMapContainer:DeprecationWarning",
+    "ignore:.*pkg_resources is deprecated as an API.:DeprecationWarning",
+]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "session"
+mongo_params = ""
+
+[tool.black]
+line-length = 120
+target-version = ['py312']
+
+[tool.isort]
+profile = "black"
+
+[tool.mypy]
+python_version = "3.12"
+warn_unused_configs = true
+packages = "fastapi_factory_utilities"
+mypy_path  = "src:tests"
+namespace_packages = true
+plugins = ["pydantic.mypy"]
+follow_imports = "silent"
+warn_redundant_casts = true
+warn_unused_ignores = true
+disallow_any_generics = true
+check_untyped_defs = true
+no_implicit_reexport = true
+
+# for strict mypy: (this is the tricky one :-))
+disallow_untyped_defs = true
+
+[tool.pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
+warn_required_dynamic_aliases = true
+
+[tool.ruff]
+# Same as Black.
+line-length = 120
+indent-width = 4
+
+[tool.ruff.lint]
+select = ["D","F","E","W","I","UP","PL","N","RUF"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+docstring-code-format = true
+docstring-code-line-length = 120
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"

fastapi_factory_utilities-0.1.0/src/fastapi_factory_utilities/__main__.py

@@ -0,0 +1,6 @@
+"""Re-Use the main function from the example module."""
+
+from fastapi_factory_utilities.example import main
+
+if __name__ == "__main__":
+    main()

fastapi_factory_utilities-0.1.0/src/fastapi_factory_utilities/core/__init__.py

@@ -0,0 +1 @@
+"""Python Factory Core Module."""

fastapi_factory_utilities-0.1.0/src/fastapi_factory_utilities/core/api/__init__.py

@@ -0,0 +1,25 @@
+"""Define the API for the Python Factory."""
+
+from fastapi import APIRouter
+
+from .tags import TagEnum
+from .v1.sys import api_v1_sys
+
+api: APIRouter = APIRouter(prefix="/api")
+
+### API v1 ###
+# Prefix the API with /api/v1
+api_v1: APIRouter = APIRouter(prefix="/v1")
+api_v1.include_router(router=api_v1_sys)
+
+
+### API v2 ###
+# Prefix the API with /api/v2
+api_v2: APIRouter = APIRouter(prefix="/v2")
+
+
+### Include the API routers ###
+api.include_router(router=api_v1)
+api.include_router(router=api_v2)
+
+__all__: list[str] = ["api", "TagEnum"]

fastapi_factory_utilities-0.1.0/src/fastapi_factory_utilities/core/api/tags.py

@@ -0,0 +1,9 @@
+"""Provides the Tag as Enum."""
+
+from enum import StrEnum, auto
+
+
+class TagEnum(StrEnum):
+    """Define Tag for OpenAPI Description."""
+
+    SYS = auto()

fastapi_factory_utilities-0.1.0/src/fastapi_factory_utilities/core/api/v1/sys/__init__.py

@@ -0,0 +1,12 @@
+"""Package for system related API endpoints."""
+
+from fastapi import APIRouter
+
+from .health import api_v1_sys_health
+from .readiness import api_v1_sys_readiness
+
+api_v1_sys = APIRouter(prefix="/sys")
+api_v1_sys.include_router(router=api_v1_sys_health)
+api_v1_sys.include_router(router=api_v1_sys_readiness)
+
+__all__: list[str] = ["api_v1_sys"]

fastapi_factory_utilities-0.1.0/src/fastapi_factory_utilities/core/api/v1/sys/health.py

@@ -0,0 +1,53 @@
+"""API v1 sys health module.
+
+Provide the Get health endpoint
+"""
+
+from enum import StrEnum
+from http import HTTPStatus
+
+from fastapi import APIRouter, Response
+from pydantic import BaseModel
+
+api_v1_sys_health = APIRouter(prefix="/health")
+
+
+class HealthStatusEnum(StrEnum):
+    """Health status enum."""
+
+    HEALTHY = "healthy"
+    UNHEALTHY = "unhealthy"
+
+
+class HealthResponseModel(BaseModel):
+    """Health response schema."""
+
+    status: HealthStatusEnum
+
+
+@api_v1_sys_health.get(
+    path="",
+    tags=["sys"],
+    response_model=HealthResponseModel,
+    responses={
+        HTTPStatus.OK.value: {
+            "model": HealthResponseModel,
+            "description": "Health status.",
+        },
+        HTTPStatus.INTERNAL_SERVER_ERROR.value: {
+            "model": HealthResponseModel,
+            "description": "Internal server error.",
+        },
+    },
+)
+def get_api_v1_sys_health(response: Response) -> HealthResponseModel:
+    """Get the health of the system.
+
+    Args:
+        response (Response): The response object.
+
+    Returns:
+        HealthResponse: The health status.
+    """
+    response.status_code = HTTPStatus.OK
+    return HealthResponseModel(status=HealthStatusEnum.HEALTHY)

fastapi_factory_utilities-0.1.0/src/fastapi_factory_utilities/core/api/v1/sys/readiness.py

@@ -0,0 +1,53 @@
+"""API v1 sys readiness module.
+
+Provide the Get readiness endpoint
+"""
+
+from enum import StrEnum
+from http import HTTPStatus
+
+from fastapi import APIRouter, Response
+from pydantic import BaseModel
+
+api_v1_sys_readiness = APIRouter(prefix="/readiness")
+
+
+class ReadinessStatusEnum(StrEnum):
+    """Readiness status enum."""
+
+    READY = "ready"
+    NOT_READY = "not_ready"
+
+
+class ReadinessResponseModel(BaseModel):
+    """Readiness response schema."""
+
+    status: ReadinessStatusEnum
+
+
+@api_v1_sys_readiness.get(
+    path="",
+    tags=["sys"],
+    response_model=ReadinessResponseModel,
+    responses={
+        HTTPStatus.OK.value: {
+            "model": ReadinessResponseModel,
+            "description": "Readiness status.",
+        },
+        HTTPStatus.INTERNAL_SERVER_ERROR.value: {
+            "model": ReadinessResponseModel,
+            "description": "Internal server error.",
+        },
+    },
+)
+def get_api_v1_sys_readiness(response: Response) -> ReadinessResponseModel:
+    """Get the readiness of the system.
+
+    Args:
+        response (Response): The response object.
+
+    Returns:
+        ReadinessResponse: The readiness status.
+    """
+    response.status_code = HTTPStatus.OK
+    return ReadinessResponseModel(status=ReadinessStatusEnum.READY)

fastapi_factory_utilities-0.1.0/src/fastapi_factory_utilities/core/app/__init__.py

@@ -0,0 +1,19 @@
+"""Provides the core application module for the Python Factory."""
+
+from .base import (
+    AppConfigAbstract,
+    ApplicationConfigFactoryException,
+    ApplicationFactoryException,
+    BaseApplication,
+    BaseApplicationException,
+)
+from .enums import EnvironmentEnum
+
+__all__: list[str] = [
+    "BaseApplication",
+    "AppConfigAbstract",
+    "EnvironmentEnum",
+    "ApplicationConfigFactoryException",
+    "ApplicationFactoryException",
+    "BaseApplicationException",
+]

fastapi_factory_utilities-0.1.0/src/fastapi_factory_utilities/core/app/base/__init__.py

@@ -0,0 +1,17 @@
+"""Package for the base application, abstract config classes and related exceptions."""
+
+from .application import BaseApplication
+from .config_abstract import AppConfigAbstract
+from .exceptions import (
+    ApplicationConfigFactoryException,
+    ApplicationFactoryException,
+    BaseApplicationException,
+)
+
+__all__: list[str] = [
+    "BaseApplication",
+    "AppConfigAbstract",
+    "ApplicationConfigFactoryException",
+    "ApplicationFactoryException",
+    "BaseApplicationException",
+]