Metadata-Version: 2.1
Name: healthchecks_wrapper
Version: 0.1.5
Summary: Context manager around service provided by HealthChecks for easy use
Home-page: https://github.com/samarpan-rai/healthchecks_wrapper
Author: Samarpan Rai
Author-email: samarpan-rai@live.com
License: MIT license
Description: # Simple HealthChecks Wrapper
        
        
        [<img src="https://img.shields.io/pypi/v/healthchecks-wrapper.svg">](https://pypi.org/project/healthchecks-wrapper)
        [<img src="https://readthedocs.org/projects/healthchecks-wrapper/badge/?version=latest">](https://healthchecks-wrapper.readthedocs.io/en/latest/?badge=latest)
        [![buy me a coffee](https://img.shields.io/badge/If%20you%20like%20it-Buy%20me%20a%20coffee-orange.svg?style=for-the-badge)](https://www.buymeacoffee.com/samarpanrai)
        
        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
        async with HealthCheck(valid_ping_url):
            # Do your job
            await asyncio.sleep(1) # Read database async
            print("hi")
        ```
        
        
        [![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.
        
        
        
Keywords: healthchecks_context_manager
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Requires-Python: >=3.6
Description-Content-Type: text/markdown
