Skip to main content

Unified health/ready endpoints + checks for services (Django/FastAPI).

Project description

PulseCheck

Unified health, liveness, and readiness checks for Python microservices.

PulseCheck is a framework-agnostic health check library designed for modern Python services.

It provides a pluggable health engine with adapters for FastAPI and Django, built with Kubernetes readiness/liveness semantics in mind.


Features

  • Framework-agnostic core

  • FastAPI adapter

  • Django adapter

  • Pluggable dependency checks:

    • SQLAlchemy (async)
    • Django ORM
    • Redis (sync & async)
    • RabbitMQ (Kombu)
    • Celery worker inspection
    • HTTP dependency checks
  • Configurable timeouts

  • Degraded vs unhealthy states

  • Optional dependency extras

  • Zero forced framework pollution

  • Production-ready JSON schema

  • Kubernetes-compatible


Installation

Install core only:

pip install pulsecheck-py

Install with FastAPI support:

pip install pulsecheck-py[fastapi]

Install with Django support:

pip install pulsecheck-py[django]

Install with multiple dependency checks:

pip install pulsecheck-py[fastapi,redis_async,sqlalchemy_async,rabbitmq,celery]

FastAPI Example

from fastapi import FastAPI 
from pulsecheck.core import HealthRegistry 
from pulsecheck.core.checks import SQLAlchemyAsyncCheck 
from pulsecheck.fastapi import make_health_router

app = FastAPI()

registry = HealthRegistry(environment="prod") 
registry.register(SQLAlchemyAsyncCheck(engine))

app.include_router(make_health_router(registry))

Endpoints:

GET /health 
GET /health/live 
GET /health/ready

Django Example

from pulsecheck.core import HealthRegistry 
from pulsecheck.core.checks import DjangoDBCheck 
from pulsecheck.django import make_urlpatterns

registry = HealthRegistry(environment="prod") 
registry.register(DjangoDBCheck())

urlpatterns = [
    *make_urlpatterns(registry)
]

Health Response Format

{
  "status": "HEALTHY",
  "timestamp": "2026-02-15T12:34:56Z",
  "environment": "prod",
  "checks": {
      "database": {
          "status": "HEALTHY",
          "response_time_ms": 4.3
      }
  }
}

States:

  • HEALTHY
  • DEGRADED
  • UNHEALTHY

Design Philosophy

PulseCheck separates:

  • Core health aggregation logic

  • Dependency checks

  • Framework adapters

This ensures:

  • No tight framework coupling

  • Optional extras per ecosystem

  • Clean dependency graphs

  • Compatibility across service architectures

Optional Dependencies (Extras)

Extra Installs
fastapi FastAPI adapter
django Django adapter
redis_async Async Redis check
redis_sync Sync Redis check
rabbitmq Kombu-based AMQP check
celery Celery inspect check
sqlalchemy_async Async SQLAlchemy check
http HTTP dependency check

Testing

PulseCheck is tested against:

  • Python 3.10+

  • FastAPI

  • Django

  • Async and sync dependency scenarios


Intended Use

PulseCheck is designed for:

  • Microservices

  • Containerized applications

  • Kubernetes environments

  • Internal APIs

  • Distributed systems

It is not a monitoring system.
It is a lightweight dependency availability indicator.


Contributing

Issues and pull requests are welcome.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pulsecheck_py-0.1.2.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pulsecheck_py-0.1.2-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file pulsecheck_py-0.1.2.tar.gz.

File metadata

  • Download URL: pulsecheck_py-0.1.2.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for pulsecheck_py-0.1.2.tar.gz
Algorithm Hash digest
SHA256 a497a2b5a360c80ae3119bf020b1eab4bb3bc57175e5bc7abbca71be21b32211
MD5 26c51560562f677f94b1a55f2588def3
BLAKE2b-256 85bb2a54db2ba684a8d0148f5e0ead018f7eef385cdabe49a3563f37779f632f

See more details on using hashes here.

File details

Details for the file pulsecheck_py-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: pulsecheck_py-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 3.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for pulsecheck_py-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f4832c3b5be4fc5e1bfd1356386bd3b853895ff56bd2d6c17942d48e8511e2a7
MD5 85b74b6f117485ae46e363d7243a3156
BLAKE2b-256 403c1f73f982e5ee2f4218cb54a7804ba2095f48fb156106acc48a47f1e1d585

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page