# 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 pyheartbeat
# Example
```python
======================================================================================================
from pyheartbeat import setUrl, heartbeat, killHeartbeat
# Set the URL for sending pulses
setUrl("https://your_url")
# Start the heartbeat with a pulse every x seconds
heartbeat(interval = 600, name = 'process name', description = 'process description',
additional_info = 'additional info', show_response = True, show_logs = 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": "pyheartbeat",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "pyheartbeat, heartbeat_library, 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/d1/3e/e0d0859eae8d8848fc52fca67b2ee3dde4e084f2bccfbc3208da7eec046a/pyheartbeat-0.0.4.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 pyheartbeat\r\n\r\n# Example\r\n\r\n```python\r\n======================================================================================================\r\nfrom pyheartbeat import setUrl, heartbeat, killHeartbeat\r\n\r\n# Set the URL for sending pulses\r\nsetUrl(\"https://your_url\")\r\n\r\n# Start the heartbeat with a pulse every x seconds\r\nheartbeat(interval = 600, name = 'process name', description = 'process description',\r\nadditional_info = 'additional info', show_response = True, show_logs = 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.0.4",
"project_urls": null,
"split_keywords": [
"pyheartbeat",
" heartbeat_library",
" 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": "d13ee0d0859eae8d8848fc52fca67b2ee3dde4e084f2bccfbc3208da7eec046a",
"md5": "7ecc41124afe97e8074c74c4c4c3b76c",
"sha256": "8c00d2f6864a465ab4331b023b0b3372413a3e7bc63c286634b63a01e28057f5"
},
"downloads": -1,
"filename": "pyheartbeat-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "7ecc41124afe97e8074c74c4c4c3b76c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3712,
"upload_time": "2024-05-14T13:52:48",
"upload_time_iso_8601": "2024-05-14T13:52:48.932572Z",
"url": "https://files.pythonhosted.org/packages/d1/3e/e0d0859eae8d8848fc52fca67b2ee3dde4e084f2bccfbc3208da7eec046a/pyheartbeat-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-14 13:52:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyheartbeat"
}
JSON