{"categories":[{"label":"Python Modules","url":"https://skillfed.io/packages/category/software-development-libraries-python-modules/15"},{"label":"Build Tools","url":"https://skillfed.io/packages/category/software-development-build-tools/3"}],"enrichment":{"capability":"Adds a health check endpoint to FastAPI applications by evaluating a list of condition callables and returning appropriate success or failure responses.","skillfed_tags":["health-check","microservices","observability"],"use_cases":["Kubernetes liveness and readiness probes that check whether your FastAPI service and its dependencies are operational","Load balancer health checks that verify database connectivity and other critical service dependencies before routing traffic","Monitoring dashboards that poll a standardized health endpoint to track service availability across a microservices cluster","Graceful shutdown detection by returning failure status when the service is shutting down or entering maintenance mode"],"what_it_does":"fastapi-health is a lightweight library that implements the Health Check API pattern for FastAPI applications. It provides a single `health()` function that accepts a list of condition callables and generates a health check endpoint that evaluates each condition and returns an appropriate HTTP response (200 for success, 503 for failure by default). Each condition can return either a boolean or a dictionary; conditions can also use FastAPI's dependency injection system to access resources like database sessions.\n\nThe package is designed to be minimal and straightforward: you define your health conditions as functions, pass them to `health()`, and attach the result to your FastAPI app as a route. It supports customization of response bodies and HTTP status codes for both success and failure scenarios. The package depends only on fastapi and has no other external runtime dependencies.","worth_installing":"Yes, if you need a simple health check endpoint and can accept that the package is no longer maintained. The library is small, has no known vulnerabilities, and works with Python versions 3.6 through 3.9. However, verify compatibility with your specific FastAPI version before deploying to production, and be prepared to fork or replace it if FastAPI introduces breaking changes."},"id":"fastapi-health","links":{"html":"https://skillfed.io/packages/fastapi-health","md":"https://skillfed.io/packages/fastapi-health.md","pypi":"https://pypi.org/project/fastapi-health/"},"maintenance":{"status":"abandoned"},"meta":{"latest_release":"2021-08-20","license_spdx":null,"license_treatment":"permissive","name":"fastapi-health","python_support":"supports_current","summary":"Heath check on FastAPI applications."},"popularity":{"monthly_downloads":237494,"position":8956,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.4.0"}