https://github.com/samarpan-rai/healthchecks_wrapper

https://github.com/samarpan-rai/healthchecks_wrapper

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/samarpan-rai/healthchecks_wrapper
• Owner: samarpan-rai
• License: mit
• Created: 2021-12-21T20:41:00.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-23T11:02:07.000Z (over 1 year ago)
• Last Synced: 2024-11-07T20:54:43.801Z (2 months ago)
• Language: Python
• Size: 49.8 KB
• Stars: 4
• Watchers: 1
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
# Simple HealthChecks Wrapper

[](https://pypi.org/project/healthchecks-wrapper)

[](https://healthchecks-wrapper.readthedocs.io/en/latest/?badge=latest)

[![Downloads](https://static.pepy.tech/badge/healthchecks-wrapper/month)](https://pepy.tech/project/healthchecks-wrapper)

Context manager around service provided by [healthchecks.io](https://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](https://healthchecks.io/) and create a check. You need to copy the url of the check endpoint.

Install the library

```bash

pip install healthchecks-wrapper

```

Use it in your code

```python

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()

```

[![buy me a coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/samarpanrai)

### Credits

This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage)

 project template.