# HawkFlow.ai
## Monitoring for anyone that writes code
1. Install the pip package `pip install hawkflow`
2. Usage:
```python
import time
from hawkflowclient.hawkflow_api import *
# authenticate with your API key
hf = HawkflowAPI("YOUR_API_KEY")
# start timing your code - pass through process (required) and meta (optional) parameters
print("sending timing start data to hawkflow")
hf.start("your_process_name", "your_meta_data")
# do some work
print("sleeping for 5 seconds...")
time.sleep(5)
# end timing this piece of code - process (required) and meta (optional) parameters should match the start
print("sending timing end data to hawkflow")
hf.end("your_process_name", "your_meta_data")
```
More examples: [HawkFlow.ai Python examples](https://github.com/hawkflow/hawkflow-examples/tree/master/python)
Read the docs: [HawkFlow.ai documentation](https://docs.hawkflow.ai/)
## What is HawkFlow.ai?
HawkFlow.ai is a new monitoring platform that makes it easier than ever to make monitoring part of your development process. Whether you are an Engineer, a Data Scientist, an Analyst, or anyone else that writes code, HawkFlow.ai helps you and your team take ownership of monitoring.
Raw data
{
"_id": null,
"home_page": null,
"name": "hawkflow",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "hawkflow, hawkflowclient, monitoring",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/2d/e0/a2802da543593f1c3f9a0b2383bfff735b577e2d732a494190ebb1be841f/hawkflow-0.0.9953.tar.gz",
"platform": null,
"description": "\n\n# HawkFlow.ai\n\n## Monitoring for anyone that writes code\n\n1. Install the pip package `pip install hawkflow`\n2. Usage:\n```python\nimport time\n\nfrom hawkflowclient.hawkflow_api import *\n\n# authenticate with your API key\nhf = HawkflowAPI(\"YOUR_API_KEY\")\n\n# start timing your code - pass through process (required) and meta (optional) parameters\nprint(\"sending timing start data to hawkflow\")\nhf.start(\"your_process_name\", \"your_meta_data\")\n\n# do some work\nprint(\"sleeping for 5 seconds...\")\ntime.sleep(5)\n\n# end timing this piece of code - process (required) and meta (optional) parameters should match the start\nprint(\"sending timing end data to hawkflow\")\nhf.end(\"your_process_name\", \"your_meta_data\")\n``` \n\n\nMore examples: [HawkFlow.ai Python examples](https://github.com/hawkflow/hawkflow-examples/tree/master/python)\n\nRead the docs: [HawkFlow.ai documentation](https://docs.hawkflow.ai/)\n\n## What is HawkFlow.ai?\n\nHawkFlow.ai is a new monitoring platform that makes it easier than ever to make monitoring part of your development process. Whether you are an Engineer, a Data Scientist, an Analyst, or anyone else that writes code, HawkFlow.ai helps you and your team take ownership of monitoring.\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "HawkFlow.ai",
"version": "0.0.9953",
"project_urls": {
"Homepage": "https://github.com/hawkflow/hawkflow-py"
},
"split_keywords": [
"hawkflow",
" hawkflowclient",
" monitoring"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ffbbe249a34703ae1cd7e47d1dab9e32b725b4f971a3a2d9bc04fa5de003bb54",
"md5": "d2333a2d3a60e9c0eae25b9abd09f10d",
"sha256": "6ae464acfa2e15ce77c514766c73b772fbc768fc357248898019041a98bc903e"
},
"downloads": -1,
"filename": "hawkflow-0.0.9953-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d2333a2d3a60e9c0eae25b9abd09f10d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9461,
"upload_time": "2024-07-18T06:20:53",
"upload_time_iso_8601": "2024-07-18T06:20:53.864895Z",
"url": "https://files.pythonhosted.org/packages/ff/bb/e249a34703ae1cd7e47d1dab9e32b725b4f971a3a2d9bc04fa5de003bb54/hawkflow-0.0.9953-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2de0a2802da543593f1c3f9a0b2383bfff735b577e2d732a494190ebb1be841f",
"md5": "9d37c717192a420af6eee3daeaeb527e",
"sha256": "65f7b6f0a5579500c961d43603ae3dc3fd81d56d84a3d9609e3825ce74105e61"
},
"downloads": -1,
"filename": "hawkflow-0.0.9953.tar.gz",
"has_sig": false,
"md5_digest": "9d37c717192a420af6eee3daeaeb527e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 6937,
"upload_time": "2024-07-18T06:20:55",
"upload_time_iso_8601": "2024-07-18T06:20:55.273155Z",
"url": "https://files.pythonhosted.org/packages/2d/e0/a2802da543593f1c3f9a0b2383bfff735b577e2d732a494190ebb1be841f/hawkflow-0.0.9953.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-18 06:20:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hawkflow",
"github_project": "hawkflow-py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "hawkflow"
}
JSON
