python-flashapi 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

flashapi/adapters/django.py

@@ -12,6 +12,7 @@ from flashapi.core.schema import Model, ModelSchema
 from flashapi.core.visibility import export_fields, filter_response, writable_fields
 from flashapi.docs.openapi import generate_openapi_schema, get_swagger_html
 from flashapi.features import apply_filters, apply_search, apply_sorting, paginate
+from flashapi.features.health import get_health_check
 from flashapi.inspectors import inspect_model
 from flashapi.storage.orm import DjangoORMStorage
 
@@ -113,6 +114,7 @@ def generate_urls(
         ))
 
     urlpatterns.extend(_create_api_root_view(all_schemas, docs))
+    urlpatterns.extend(_create_health_views())
 
     return urlpatterns
 
@@ -769,3 +771,38 @@ def _create_django_views(
             patterns.append(path(f"{table}/<str:item_id>/history/", history_view, name=f"{table}_history"))
 
     return patterns
+
+
+def _create_health_views():
+    """Create health check views for production monitoring."""
+    from django.http import JsonResponse
+    from django.urls import path
+
+    health_check = get_health_check()
+
+    def liveness_view(request):
+        """Liveness probe — is the application running?"""
+        return JsonResponse(health_check.liveness())
+
+    def readiness_view(request):
+        """Readiness probe — is the application ready to serve traffic?"""
+        data, status_code = health_check.readiness()
+        return JsonResponse(data, status=status_code)
+
+    # Register database check for Django ORM
+    def check_database():
+        try:
+            from django.db import connection
+            with connection.cursor() as cursor:
+                cursor.execute("SELECT 1")
+            return True
+        except Exception:
+            return False
+
+    health_check.register_check("database", check_database)
+    health_check.mark_ready()
+
+    return [
+        path("health/", liveness_view, name="health_liveness"),
+        path("ready/", readiness_view, name="health_readiness"),
+    ]

flashapi/adapters/fastapi.py

@@ -14,6 +14,7 @@ from flashapi.core.visibility import export_fields, filter_response, writable_fi
 from flashapi.features import apply_filters, apply_search, apply_sorting, paginate
 from flashapi.features.dashboard import DASHBOARD_HTML, MetricsCollector
 from flashapi.features.export import CONTENT_TYPES, EXPORTERS
+from flashapi.features.health import get_health_check
 from flashapi.inspectors import inspect_model
 from flashapi.storage.auto import AutoStorage
 from flashapi.storage.sqlalchemy import SQLAlchemyStorage
@@ -143,6 +144,7 @@ class FlashAPI:
         self._add_dashboard_routes()
         self._add_websocket_route()
         self._add_api_root()
+        self._add_health_routes()
 
     def _prepare_model(self, model_entry) -> None:
         wrapper = model_entry if isinstance(model_entry, Model) else Model(model_entry)
@@ -248,6 +250,36 @@ class FlashAPI:
             }
             return {"resources": resources, "links": links}
 
+    def _add_health_routes(self) -> None:
+        """Add health check endpoints for production monitoring."""
+        health_check = get_health_check()
+
+        @self._app.get("/health", tags=["Health"], include_in_schema=False)
+        async def liveness():
+            """Liveness probe — is the application running?"""
+            return health_check.liveness()
+
+        @self._app.get("/ready", tags=["Health"], include_in_schema=False)
+        async def readiness():
+            """Readiness probe — is the application ready to serve traffic?"""
+            data, status_code = health_check.readiness()
+            return JSONResponse(content=data, status_code=status_code)
+
+        # Register database check if using SQLAlchemy
+        if self._session_factory:
+            def check_database():
+                try:
+                    session = self._session_factory()
+                    session.execute("SELECT 1")
+                    session.close()
+                    return True
+                except Exception:
+                    return False
+            health_check.register_check("database", check_database)
+
+        # Mark ready after all routes are registered
+        health_check.mark_ready()
+
     def _add_rate_limit_middleware(self) -> None:
         from starlette.middleware.base import BaseHTTPMiddleware
 

flashapi/adapters/flask.py

@@ -13,6 +13,7 @@ from flashapi.core.schema import Model, ModelSchema
 from flashapi.core.visibility import export_fields, filter_response, writable_fields
 from flashapi.docs.openapi import generate_openapi_schema, get_swagger_html
 from flashapi.features import apply_filters, apply_search, apply_sorting, paginate
+from flashapi.features.health import get_health_check
 from flashapi.inspectors import inspect_model
 from flashapi.storage.auto import AutoStorage
 from flashapi.storage.sqlalchemy import SQLAlchemyStorage
@@ -138,6 +139,7 @@ def register_models(
         _add_docs_routes(blueprint, all_schemas, custom_routes or [], flask_app=app)
 
     _add_api_root_route(blueprint, all_schemas, base_path, docs)
+    _add_health_routes(app, session_factory)
 
     app.register_blueprint(blueprint)
 
@@ -726,3 +728,35 @@ def _create_flask_routes(
                 mimetype=CONTENT_TYPES[fmt],
                 headers={"Content-Disposition": f'attachment; filename="{_table}.{fmt}"'},
             )
+
+
+def _add_health_routes(app, session_factory) -> None:
+    """Add health check endpoints for production monitoring."""
+    from flask import jsonify
+    health_check = get_health_check()
+
+    @app.route("/health")
+    def liveness():
+        """Liveness probe — is the application running?"""
+        return jsonify(health_check.liveness())
+
+    @app.route("/ready")
+    def readiness():
+        """Readiness probe — is the application ready to serve traffic?"""
+        data, status_code = health_check.readiness()
+        return jsonify(data), status_code
+
+    # Register database check if using SQLAlchemy
+    if session_factory:
+        def check_database():
+            try:
+                session = session_factory()
+                session.execute("SELECT 1")
+                session.close()
+                return True
+            except Exception:
+                return False
+        health_check.register_check("database", check_database)
+
+    # Mark ready after all routes are registered
+    health_check.mark_ready()

flashapi/features/health.py

@@ -0,0 +1,69 @@
+"""
+Health check endpoints for production monitoring.
+
+Provides /health (liveness) and /ready (readiness) endpoints for Kubernetes,
+load balancers, and monitoring systems.
+"""
+
+from __future__ import annotations
+
+import time
+from typing import Any
+
+
+class HealthCheck:
+    """Health check manager with liveness and readiness probes."""
+
+    def __init__(self) -> None:
+        self._start_time = time.time()
+        self._ready = False
+        self._checks: dict[str, callable] = {}
+
+    def mark_ready(self) -> None:
+        """Mark the application as ready to receive traffic."""
+        self._ready = True
+
+    def register_check(self, name: str, check_fn: callable) -> None:
+        """Register a custom readiness check (e.g., database connection)."""
+        self._checks[name] = check_fn
+
+    def liveness(self) -> dict[str, Any]:
+        """
+        Liveness probe — is the application running?
+        Returns 200 if alive, should return 5xx if deadlocked/crashed.
+        """
+        uptime = int(time.time() - self._start_time)
+        return {"status": "ok", "uptime": uptime}
+
+    def readiness(self) -> tuple[dict[str, Any], int]:
+        """
+        Readiness probe — is the application ready to serve traffic?
+        Returns 200 if ready, 503 if not yet ready or dependencies failing.
+        """
+        if not self._ready:
+            return {"status": "not_ready", "reason": "Application still initializing"}, 503
+
+        failed_checks = []
+        for name, check_fn in self._checks.items():
+            try:
+                if not check_fn():
+                    failed_checks.append(name)
+            except Exception as e:
+                failed_checks.append(f"{name}: {e}")
+
+        if failed_checks:
+            return {
+                "status": "not_ready",
+                "failed_checks": failed_checks,
+            }, 503
+
+        uptime = int(time.time() - self._start_time)
+        return {"status": "ready", "uptime": uptime, "checks_passed": len(self._checks)}, 200
+
+
+_health = HealthCheck()
+
+
+def get_health_check() -> HealthCheck:
+    """Get the global health check instance."""
+    return _health

{python_flashapi-0.2.0.dist-info → python_flashapi-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: python-flashapi
-Version: 0.2.0
+Version: 0.3.0
 Summary: Define your models. FlashAPI does the rest.
 Project-URL: Homepage, https://github.com/HackermanMe/flashapi
 Project-URL: Documentation, https://github.com/HackermanMe/flashapi#readme
@@ -88,7 +88,12 @@ Part of the **FlashAPI Ecosystem** — ensuring SDK client compatibility across
 ## Installation
 
 ```bash
-pip install python-flashapi[fastapi]   # or python-flashapi[flask] or python-flashapi[all]
+# x-release-please-start-version
+pip install python-flashapi==0.2.0
+# x-release-please-end
+
+# With framework extras:
+pip install python-flashapi[fastapi]   # or [flask] or [django] or [all]
 ```
 
 ---

{python_flashapi-0.2.0.dist-info → python_flashapi-0.3.0.dist-info}/RECORD

@@ -5,9 +5,9 @@ flashapi/flask.py,sha256=v-uSb9QSxj20w2iyDgaM4uED82XHLWEO9CRxGT8KCVc,137
 flashapi/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 flashapi/adapters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 flashapi/adapters/base.py,sha256=DbXmwMZzZYums4YaJ-OlY8bJxTbGJTxApSfmf5NO-0w,329
-flashapi/adapters/django.py,sha256=6rs_mFkkF4qmnJ8DB69nV8mbYuMde1bHCzLBrN5MypI,32633
-flashapi/adapters/fastapi.py,sha256=63lcUoK2a6k1RdwRb1kIH2zz-D0tqouJ3MUALUMJ0WI,36820
-flashapi/adapters/flask.py,sha256=peVQQ8NTGDLpuplAvUbYTuXGF59eeBbFb_9HTEcxvfE,29121
+flashapi/adapters/django.py,sha256=G5vbeaiK0ENzNoo0rrkbiWs6yQMN1rCnYsgsrjhGegc,33841
+flashapi/adapters/fastapi.py,sha256=sU2j7VIPn6WrmdwOl9_eWQaCgheluGGnq9Q9sQeD3-g,38129
+flashapi/adapters/flask.py,sha256=OeJ1M8U_XyUi7_7h91pif1zphZU71Nnz571FTDHHZQY,30256
 flashapi/core/__init__.py,sha256=8Ex4oCFI34F4xkA6Q6zSSQ-jE2uw1w-C20yl-Yg3f3c,297
 flashapi/core/custom_routes.py,sha256=-K0xDx-bW1yJtcJxh5ZdFUI0MzwIKoNKMJCuocdZuWI,8432
 flashapi/core/pluralize.py,sha256=nL_JwNHwEbz6n3HXdfA1We9_MRNR-cLn4VT-Hz1RW1g,2406
@@ -23,6 +23,7 @@ flashapi/features/auth.py,sha256=FVYb6x6VAIEvAp2xY8LL5I2E2PFdPe5v8dDGmWQfWLc,458
 flashapi/features/dashboard.py,sha256=eaOJmrJ5lRxDDyo4BhCp5qaNHDn0AUW4IlqhAIL38as,18239
 flashapi/features/export.py,sha256=M7RryPDgDZn1VlouZNzhvhrZ00k1e0HyyZlAfjYMSiE,4912
 flashapi/features/filtering.py,sha256=ONPWbVVTHlTRlxUoOcRNkL_a67osr12CJHKKBXHwDPg,3826
+flashapi/features/health.py,sha256=g-vLoIAmS2L8pq7cvG9TX7h60rPEAa6YMlog71AW-u4,2140
 flashapi/features/pagination.py,sha256=396lvL_c6j3tNNodpPHkYDRkxkDmex2q9HmrUeOpLRA,464
 flashapi/features/rate_limit.py,sha256=LEI8UqWHEH7TREqaD0lDhhR5jZz8VF5qdu0gBxOVBSc,1313
 flashapi/features/search.py,sha256=0V0S8Mo2zb_BEeGbNYg8Y4ZF9njLNhwZAkrVrODW3Dc,611
@@ -41,8 +42,8 @@ flashapi/storage/auto.py,sha256=6K6_TSFU2NJSIaFqE3qbGFIY1H8uaL0iLGBEVvUpifs,7611
 flashapi/storage/base.py,sha256=8C6DL9LAWQ3lIDFKTKD3chXuDNr2LTc5yWoZYQPpKq4,1089
 flashapi/storage/orm.py,sha256=F_hOxspYkKzH1l_m48jRNdv7TGvp4OM6EwpMixfeP9E,4556
 flashapi/storage/sqlalchemy.py,sha256=FoSHWDydicRvns8ufO1vnb2o0dGwvASd88sQ3wh1SAI,6651
-python_flashapi-0.2.0.dist-info/METADATA,sha256=nRRFMQ3s7x8n0HomOcd-B1bh1pGITxazny9vczB-1tU,10793
-python_flashapi-0.2.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
-python_flashapi-0.2.0.dist-info/licenses/LICENSE,sha256=thh4-7oEXj4Tz_CHQciJHSnRqxCNRRuse5ac-BwBU5c,10772
-python_flashapi-0.2.0.dist-info/licenses/NOTICE,sha256=5-7uAManZL-6L6TGoHqSVBioA5MZ_UAzCPi97Ahtvw8,164
-python_flashapi-0.2.0.dist-info/RECORD,,
+python_flashapi-0.3.0.dist-info/METADATA,sha256=TygInIQvoXhmIDeRMwPF8hCcn_sEdtXTEYsggjBZgPg,10892
+python_flashapi-0.3.0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+python_flashapi-0.3.0.dist-info/licenses/LICENSE,sha256=thh4-7oEXj4Tz_CHQciJHSnRqxCNRRuse5ac-BwBU5c,10772
+python_flashapi-0.3.0.dist-info/licenses/NOTICE,sha256=5-7uAManZL-6L6TGoHqSVBioA5MZ_UAzCPi97Ahtvw8,164
+python_flashapi-0.3.0.dist-info/RECORD,,

{python_flashapi-0.2.0.dist-info → python_flashapi-0.3.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.31.0
+Generator: hatchling 1.32.0
 Root-Is-Purelib: true
 Tag: py3-none-any