Skip to main content

A lightweight utility package for pinging healthchecks to indicate liveness.

Project description


Table of Contents


HealthPing is a lightweight python package that allows users to easily include liveness monitoring in their applications. If you've got a python program running (such as a telegram bot) and find yourself wondering from time to time about its liveness, then this is the package for you! HealthPing abstracts away the task of sending request to monitoring endpoints, managing timezones and retries - offering all these in as short as two lines of code:

from health_ping import HealthPing
HealthPing(url="<id>", timezone="UTC+08:00", schedule="1 * * * *").start()

HealthPing essentially adopts the "deadman switch" approach, where it regularly sends a "heartbeat" to a monitoring service such as If a "heartbeat" does not arrive within a scheduled period, the service is assumed dead and an alert (e.g. email notification) is then sent out to the service owner.

HealthPing is published on pypi and can be easily installed with:

python3 -m pip install health_ping

Details on the usage of the package can be found on the wiki page.


As a lightweight utility package, HealthPing serves to carry out a single yet important purpose - notify the monitoring service that your application is still healthy and running. In order to assist you with that, HealthPing comes equipped with the following parameters for configuration:

  • url
  • method
  • headers
  • body
  • timezone
  • schedule
  • retries
  • pre_fire
  • post_fire
  • log_file
  • debug

For most of the use cases, specifying the url, timezone and schedule will be enough! Details on each parameter such as their default values and usage are described in the wiki page.


Technologies used by HealthPing are as below:

Done with:


Project Repository


This section will walk you through setting up a development environment if you wish to make modifications or contributions to the project.

  1. First, cd to the directory of where you wish to store the project and clone this repository. An example is provided below:
    cd /home/user/exampleuser/projects/
    git clone
  2. Once the project has been cloned, cd into it and install required dependencies with the following command:
    python3 -m pip install --no-cache-dir -r requirements.txt requirements-dev.txt
  3. Following which, create (or copy) a .env file at the root of the project using the provided .env.template. In order to run tests, you need to replace the TEST_URL variable within the .env file with any valid URL of your choice.
  4. Proceed to make changes to the project (you may also wish to add test cases if necessary) and when ready, run tests with:
    python3 -m pytest ./tests/
  5. Should you wish to build this into a package, you may run the following commands within the project root directory:
    python3 -m build


Note: Special thanks to Avery Khoo for bouncing ideas and sharing knowledge!


If you have code to contribute to the project, open a pull request and describe clearly the changes and what they are intended to do (enhancement, bug fixes etc).

Alternatively, you may contact me via discord or simply raise bugs or suggestions by opening an issue.


For any questions regarding the implementation of the project, you may also reach out on discord or drop an email to:

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

health_ping-1.0.1.tar.gz (6.7 kB view hashes)

Uploaded Source

Built Distribution

health_ping-1.0.1-py3-none-any.whl (7.5 kB view hashes)

Uploaded Python 3

Supported by

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