py-healthcheck

What it is and what it does

py-healthcheck is a lightweight library that adds HTTP endpoints to applications to expose application health status and environment information. It lets you register custom check functions that verify dependencies are running and return pass/fail results with diagnostic messages. The library also provides an EnvironmentDump class that exposes metadata about the operating system, Python environment, running process, and application config—with built-in scrubbing to avoid leaking secrets.

The package is designed for integration with external monitoring tools. It includes in-process caching (27 seconds for successes, 9 seconds for failures by default) to reduce load on backend services when monitoring systems poll the endpoint frequently. Check functions are simple callables that return a tuple of (bool, str) indicating pass/fail and a message.

Use it for:

• Expose a healthcheck endpoint for load balancers or monitoring services to verify your application is running and dependencies are available.
• Verify critical service connectivity before responding to requests by adding custom check functions.
• Expose application environment and configuration metadata via an endpoint for debugging and operational visibility.
• Reduce backend service strain by caching healthcheck results in process memory to handle frequent polling from monitoring infrastructure.
• Integrate with applications to expose health and environment data via HTTP.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides healthcheck and environment-dump endpoints for web applications to expose application status and dependency health to monitoring systems.

No. The package is abandoned (last release 2020-05-20) and receives no maintenance or security updates. While it has low install friction and no dependencies, the lack of active maintenance poses a risk for compatibility with current framework versions and leaves any issues unresolved. For new projects, choose an actively maintained healthcheck library; for existing deployments, evaluate whether you can migrate or maintain a fork.

Install

py-healthcheck on PyPI

pip install py-healthcheck

uv add py-healthcheck

poetry add py-healthcheck

Installing py-healthcheck

Before you install

Low install friction with no runtime dependencies. However, the package is abandoned—last release was 2020-05-20, with no commits since 2022-11-24. No recent maintenance or security updates.

License in practice

MIT license is permissive and imposes no restrictions on use, modification, or distribution in commercial or private projects.

Quickstart

pip install py-healthcheck

from healthcheck import HealthCheck

health = HealthCheck()

def redis_available():
    return True, "redis ok"

health.add_check(redis_available)
health.run()

Verify before relying

• Whether the package works correctly with modern versions of Flask and Tornado given its 2020 last release date.
• Whether Python 3.8+ compatibility is confirmed, as classifiers list Python 2.7 and generic Python 3 without specifics.
• Current compatibility status with actively maintained web frameworks.

Package facts

Evidence: py_healthcheck-1.10.1-py3-none-any.whl

Tags

More Monitoring packages