healthchecks-wrapper 0.1.6

Context manager around service provided by HealthChecks for easy use

Simple HealthChecks Wrapper

Context manager around service provided by healthchecks.io that will ping your check URL for both success and failure (includes stack trace).

Features

• Zero requirements outside the standard library
• Easily report the status of your python jobs
• Supports both sync and async jobs

Getting started

Make a free account with at healthchecks.io and create a check. You need to copy the url of the check endpoint.

Install the library

pip install healthchecks-wrapper

Use it in your code

from healthchecks_wrapper import HealthCheck
import asyncio
valid_ping_url = "https://hc-ping.com/b2b308a5-765c-4136-8d0a-2ff0b906e3ee"  # Replace with your job url

# Sync jobs
with HealthCheck(valid_ping_url):
    # Do your job
    print("hi")

# Async jobs requires a bit more boiler plate code
async def print_hi():
    async with HealthCheck(valid_ping_url):
        # Do your job
        await asyncio.sleep(1) # Read database async
        print("hi")

def main():
    loop = asyncio.get_event_loop()
    loop.run_until_complete(print_hi())
    loop.close()

main()

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.