heartbeat-library


Nameheartbeat-library JSON
Version 0.1.1 PyPI version JSON
download
home_pageNone
SummaryLibrary for sending pulses to a process monitoring server
upload_time2024-05-07 12:36:11
maintainerNone
docs_urlNone
authorPedro Ferreira Braz
requires_pythonNone
licenseMIT License
keywords heartbeat heartbeat-library heartbeat-api heartbeat-wrapper heartbeat-python heartbeat-python-wrapper heartbeat-python-api heartbeat-python-wrapper-api heartbeat-python-api-wrapper multithreading threading requests python-requests python-threading python-multithreading python-heartbeat python-heartbeat-api python-heartbeat-wrapper python-heartbeat-python python-heartbeat-python-wrapper python-heartbeat-python-api python-heartbeat-python-wrapper-api python-heartbeat-python-api-wrapper
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Python Heartbeat Library

The Python Heartbeat Library is a simple utility that allows you to send regular "pulses" to a specific endpoint. These pulses serve as confirmation that your main script is functioning correctly. If the main script stops for any reason, the heartbeat will also cease, indicating that something went wrong.

# Installation

You can install the Python Heartbeat Library using pip:

pip install heartbeat-library

# Example

```python
===============================================================================================================================
from heartbeat-library import setUrl, heartbeat, killHeartbeat

# Set the URL for sending pulses
setUrl("https://")

# Start the heartbeat with a pulse every 10 seconds
heartbeat(interval = 600, name = 'process name', description = 'process description', additional_info = '', show_response = True)

# Your main script logic goes here...

# When your script ends or encounters an error, stop the heartbeat
killHeartbeat()
===============================================================================================================================
```

# License

This project is licensed under the MIT License - see the LICENSE file for details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "heartbeat-library",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "heartbeat, heartbeat-library, heartbeat-api, heartbeat-wrapper, heartbeat-python, heartbeat-python-wrapper, heartbeat-python-api, heartbeat-python-wrapper-api, heartbeat-python-api-wrapper, multithreading, threading, requests, python-requests, python-threading, python-multithreading, python-heartbeat, python-heartbeat-api, python-heartbeat-wrapper, python-heartbeat-python, python-heartbeat-python-wrapper, python-heartbeat-python-api, python-heartbeat-python-wrapper-api, python-heartbeat-python-api-wrapper",
    "author": "Pedro Ferreira Braz",
    "author_email": "pbraz.pedrof@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/04/16/286f2af8fc308ff90adf8de975c3848c8f55a60d6601f5e9e05c62795361/heartbeat_library-0.1.1.tar.gz",
    "platform": null,
    "description": "# Python Heartbeat Library\r\n\r\nThe Python Heartbeat Library is a simple utility that allows you to send regular \"pulses\" to a specific endpoint. These pulses serve as confirmation that your main script is functioning correctly. If the main script stops for any reason, the heartbeat will also cease, indicating that something went wrong.\r\n\r\n# Installation\r\n\r\nYou can install the Python Heartbeat Library using pip:\r\n\r\npip install heartbeat-library\r\n\r\n# Example\r\n\r\n```python\r\n===============================================================================================================================\r\nfrom heartbeat-library import setUrl, heartbeat, killHeartbeat\r\n\r\n# Set the URL for sending pulses\r\nsetUrl(\"https://\")\r\n\r\n# Start the heartbeat with a pulse every 10 seconds\r\nheartbeat(interval = 600, name = 'process name', description = 'process description', additional_info = '', show_response = True)\r\n\r\n# Your main script logic goes here...\r\n\r\n# When your script ends or encounters an error, stop the heartbeat\r\nkillHeartbeat()\r\n===============================================================================================================================\r\n```\r\n\r\n# License\r\n\r\nThis project is licensed under the MIT License - see the LICENSE file for details.\r\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Library for sending pulses to a process monitoring server",
    "version": "0.1.1",
    "project_urls": null,
    "split_keywords": [
        "heartbeat",
        " heartbeat-library",
        " heartbeat-api",
        " heartbeat-wrapper",
        " heartbeat-python",
        " heartbeat-python-wrapper",
        " heartbeat-python-api",
        " heartbeat-python-wrapper-api",
        " heartbeat-python-api-wrapper",
        " multithreading",
        " threading",
        " requests",
        " python-requests",
        " python-threading",
        " python-multithreading",
        " python-heartbeat",
        " python-heartbeat-api",
        " python-heartbeat-wrapper",
        " python-heartbeat-python",
        " python-heartbeat-python-wrapper",
        " python-heartbeat-python-api",
        " python-heartbeat-python-wrapper-api",
        " python-heartbeat-python-api-wrapper"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0416286f2af8fc308ff90adf8de975c3848c8f55a60d6601f5e9e05c62795361",
                "md5": "ee647a94828d610d735d1fcac4159f15",
                "sha256": "dff02fb7eba54707ee81b53464d6a7b547ec0197330fffc48f76b7b03d1d85cc"
            },
            "downloads": -1,
            "filename": "heartbeat_library-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ee647a94828d610d735d1fcac4159f15",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3363,
            "upload_time": "2024-05-07T12:36:11",
            "upload_time_iso_8601": "2024-05-07T12:36:11.167127Z",
            "url": "https://files.pythonhosted.org/packages/04/16/286f2af8fc308ff90adf8de975c3848c8f55a60d6601f5e9e05c62795361/heartbeat_library-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-07 12:36:11",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "heartbeat-library"
}
        
Elapsed time: 0.42345s