python-flashapi 0.2.0__tar.gz → 0.3.0__tar.gz

python_flashapi-0.3.0/.github/workflows/release-please.yml

@@ -0,0 +1,48 @@
+name: Release Please
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          release-type: python
+          package-name: python-flashapi
+
+  publish:
+    needs: release-please
+    if: ${{ needs.release-please.outputs.release_created }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install build tools
+        run: pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        run: twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}

python_flashapi-0.3.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.3.0"
+}

{python_flashapi-0.2.0 → python_flashapi-0.3.0}/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [0.3.0](https://github.com/HackermanMe/flashapi/compare/v0.2.0...v0.3.0) (2026-08-08)
+
+
+### Features
+
+* add production health check endpoints (/health and /ready) ([cc4e881](https://github.com/HackermanMe/flashapi/commit/cc4e881f09055fa990bb054298ebc8c1f55af7af))
+
+
+### Bug Fixes
+
+* corriger les gradients et les couleurs dans les fichiers SVG du logo ([50aadaf](https://github.com/HackermanMe/flashapi/commit/50aadaff44919e5666621cc3f645dd34c1364a64))
+
+
+### Documentation
+
+* add release-please version marker in README ([515aeb8](https://github.com/HackermanMe/flashapi/commit/515aeb83c2f021bebac25d9690c4726003769746))
+
 ## 0.1.0 (2026-07-09)
 
 Initial release.

{python_flashapi-0.2.0 → python_flashapi-0.3.0}/PKG-INFO

@@ -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 → python_flashapi-0.3.0}/README.md

@@ -46,7 +46,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.3.0/docs/logo.svg

@@ -0,0 +1,25 @@
+<svg width="387" height="122" xmlns="http://www.w3.org/2000/svg">
+ <defs>
+  <linearGradient id="bolt" x1="0%" y1="0%" x2="100%" y2="100%">
+   <stop offset="0%" stop-color="#FFD700"/>
+   <stop offset="100%" stop-color="#FF8C00"/>
+  </linearGradient>
+ </defs>
+ <!-- Lightning bolt icon -->
+ <!-- FlashAPI text -->
+ <!-- Tagline -->
+ <g>
+  <title>Layer 1</title>
+  <text x="113" y="71" font-family="Inter, -apple-system, sans-serif" font-size="42" font-weight="bold" fill="#ff5000" id="svg_2" font-style="italic">Flash</text>
+  <text x="222" y="70" font-family="Inter, -apple-system, sans-serif" font-size="42" font-weight="bold" fill="url(#bolt)" id="svg_3" font-style="italic">API</text>
+  <text x="113" y="95" font-family="Inter, -apple-system, sans-serif" font-size="13" fill="#666" id="svg_4">Define your models. FlashAPI does the rest.</text>
+  <g id="svg_1">
+   <circle id="svg_5" cx="52" cy="63.5" r="48" opacity="0.35"/>
+   <circle id="svg_6" cx="52" cy="59.5" r="48" fill="#ffc400"/>
+   <circle id="svg_7" cx="52" cy="63.5" r="39" opacity="0.35"/>
+   <circle id="svg_8" cx="52" cy="59.5" r="39" fill="#ff1200"/>
+   <polygon id="svg_9" points="83,8.5 34,59.5 50.01200866699219,56.45100402832031 29.772994995117188,85.5 45,82.5 22,117.5 69,70.5 55,72.5 76,44.5 59,49.5 " opacity="0.35"/>
+   <polygon id="svg_10" fill="#ffc400" points="83,4.5 34,55.5 50.01200866699219,52.45100402832031 29.772994995117188,81.5 45,78.5 22,113.5 69,66.5 55,68.5 76,40.5 59,45.5 "/>
+  </g>
+ </g>
+</svg>

{python_flashapi-0.2.0 → python_flashapi-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "python-flashapi"
-version = "0.2.0"
+version = "0.3.0"
 description = "Define your models. FlashAPI does the rest."
 readme = "README.md"
 license = "Apache-2.0"

python_flashapi-0.3.0/release-please-config.json

@@ -0,0 +1,10 @@
+{
+  "packages": {
+    ".": {
+      "release-type": "python",
+      "package-name": "python-flashapi",
+      "bump-minor-pre-major": true,
+      "extra-files": ["pyproject.toml"]
+    }
+  }
+}

{python_flashapi-0.2.0 → python_flashapi-0.3.0}/src/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"),
+    ]

{python_flashapi-0.2.0 → python_flashapi-0.3.0}/src/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
 

{python_flashapi-0.2.0 → python_flashapi-0.3.0}/src/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()

python_flashapi-0.3.0/src/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.3.0/tests/test_health.py

@@ -0,0 +1,42 @@
+"""Tests for health check endpoints."""
+
+import pytest
+from fastapi.testclient import TestClient
+from pydantic import BaseModel
+
+from flashapi.adapters.fastapi import FlashAPI
+
+
+class TestItem(BaseModel):
+    name: str
+
+
+@pytest.fixture
+def app(tmp_path):
+    """Create a test FastAPI app."""
+    db_path = str(tmp_path / "test.db")
+    flash = FlashAPI([TestItem], database=db_path)
+    return flash.app
+
+
+def test_liveness_probe(app):
+    """Test GET /health returns liveness status."""
+    client = TestClient(app)
+    response = client.get("/health")
+    assert response.status_code == 200
+    data = response.json()
+    assert data["status"] == "ok"
+    assert "uptime" in data
+    assert isinstance(data["uptime"], int)
+
+
+def test_readiness_probe(app):
+    """Test GET /ready returns readiness status."""
+    client = TestClient(app)
+    response = client.get("/ready")
+    assert response.status_code == 200
+    data = response.json()
+    assert data["status"] == "ready"
+    assert "uptime" in data
+    assert "checks_passed" in data
+    assert data["checks_passed"] >= 0  # At least 0 checks (in-memory DB has no check)

python_flashapi-0.2.0/.github/workflows/publish.yml

@@ -1,29 +0,0 @@
-name: Publish to PyPI
-
-on:
-  push:
-    tags: ['v*']
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.12'
-
-      - name: Install build tools
-        run: pip install build twine
-
-      - name: Build package
-        run: python -m build
-
-      - name: Publish to PyPI
-        run: twine upload dist/*
-        env:
-          TWINE_USERNAME: __token__
-          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}