# Robot Trace
## Overview
**Robot Trace** is a tool designed to monitor Hamilton VENUS robot log folder
for errors and send notifications via Slack. It is based on python Watchdog
and slack webhook API with a simple http request.
## Getting Started
Follow these instructions to set up the project on your local machine for
development and testing purposes.
### Prerequisites
You will need:
- Python 3.x
- pip
- Virtualenv (optional, but recommended for environment management)
### Installation
Clone the repository and set up the environment:
```bash
git clone https://github.com/gorefbitim/robottrace.git
cd robottrace
```
Create and activate a virtual environment:
```bash
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
Install the required packages:
```bash
pip install -r requirements.txt
```
## Configuring Slack Notifications
To enable Slack notifications, you need to create a Slack App for webhook
integration or bot functionality.
### Creating a Slack App
1. Go to [Your Apps](https://api.slack.com/apps) on the Slack API website.
2. Click **Create New App**, select **From scratch**.
3. Name your app (e.g., "Robot Monitor") and select your workspace.
4. Click **Create App**.
### Configuring Incoming Webhooks (for simple notifications)
1. Select **Incoming Webhooks** from the app settings.
2. Turn on incoming webhooks.
3. Click **Add New Webhook to Workspace**.
4. Choose a channel for the app to post to and authorize it.
5. Copy the webhook URL. Use this URL in Robot Monitor to send messages to
Slack.
### Setting Bot Token (for interactive features)
1. Go to **OAuth & Permissions** in the app settings.
2. Add bot token scopes such as `chat:write` and `channels:read`.
3. Install the app in your workspace to obtain your Bot User OAuth Access
Token.
### Usage
Ensure your webhook URL or bot token is set correctly in your project
configuration.
## Running the Application
Run the application with:
```bash
python robottrace.py
```
## Contributing
We welcome contributions! Please see `CONTRIBUTING.md` for how to submit
changes and our code of conduct.
## License
This project is licensed under the GNU General Public License v3.0 - see the
[LICENSE.md](LICENSE) file for more details.
## Acknowledgments
- Thanks to all contributors who help improve this project.
Raw data
{
"_id": null,
"home_page": "https://github.com/gorefbitim/robottrace",
"name": "robottrace",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Ofer Rahat",
"author_email": "leofer@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a1/5b/814a57444137292a1baf55e0c52da3be09190d7dc13e5e939180b67e8747/robottrace-0.1.0.tar.gz",
"platform": null,
"description": "# Robot Trace\n\n## Overview\n**Robot Trace** is a tool designed to monitor Hamilton VENUS robot log folder\nfor errors and send notifications via Slack. It is based on python Watchdog\nand slack webhook API with a simple http request.\n\n## Getting Started\nFollow these instructions to set up the project on your local machine for\ndevelopment and testing purposes.\n\n### Prerequisites\nYou will need:\n\n- Python 3.x\n- pip\n- Virtualenv (optional, but recommended for environment management)\n\n### Installation\nClone the repository and set up the environment:\n```bash\ngit clone https://github.com/gorefbitim/robottrace.git\ncd robottrace\n```\n\nCreate and activate a virtual environment:\n```bash\npython -m venv venv\nsource venv/bin/activate # On Windows use `venv\\Scripts\\activate`\n```\n\nInstall the required packages:\n```bash\npip install -r requirements.txt\n```\n\n## Configuring Slack Notifications\nTo enable Slack notifications, you need to create a Slack App for webhook\nintegration or bot functionality.\n\n### Creating a Slack App\n1. Go to [Your Apps](https://api.slack.com/apps) on the Slack API website.\n2. Click **Create New App**, select **From scratch**.\n3. Name your app (e.g., \"Robot Monitor\") and select your workspace.\n4. Click **Create App**.\n\n### Configuring Incoming Webhooks (for simple notifications)\n1. Select **Incoming Webhooks** from the app settings.\n2. Turn on incoming webhooks.\n3. Click **Add New Webhook to Workspace**.\n4. Choose a channel for the app to post to and authorize it.\n5. Copy the webhook URL. Use this URL in Robot Monitor to send messages to\n Slack.\n\n### Setting Bot Token (for interactive features)\n1. Go to **OAuth & Permissions** in the app settings.\n2. Add bot token scopes such as `chat:write` and `channels:read`.\n3. Install the app in your workspace to obtain your Bot User OAuth Access\n Token.\n\n### Usage\nEnsure your webhook URL or bot token is set correctly in your project\nconfiguration.\n\n## Running the Application\nRun the application with:\n```bash\npython robottrace.py\n```\n\n## Contributing\nWe welcome contributions! Please see `CONTRIBUTING.md` for how to submit\nchanges and our code of conduct.\n\n## License\nThis project is licensed under the GNU General Public License v3.0 - see the\n[LICENSE.md](LICENSE) file for more details.\n\n## Acknowledgments\n- Thanks to all contributors who help improve this project.\n",
"bugtrack_url": null,
"license": null,
"summary": "A tool to generate slack alerts for robot errors.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/gorefbitim/robottrace"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "95b3a8cbf26beaa8f74effac522ddb7b28d50a6eaf8fe205fd2ca5f79914c18f",
"md5": "e904cb83b2d2d70bf9d42015536f975e",
"sha256": "f2674560d06a05de797b99810145de187e9a65c1b11639264ddc1724fb4d9db3"
},
"downloads": -1,
"filename": "robottrace-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e904cb83b2d2d70bf9d42015536f975e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 14897,
"upload_time": "2024-07-30T13:48:21",
"upload_time_iso_8601": "2024-07-30T13:48:21.702778Z",
"url": "https://files.pythonhosted.org/packages/95/b3/a8cbf26beaa8f74effac522ddb7b28d50a6eaf8fe205fd2ca5f79914c18f/robottrace-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a15b814a57444137292a1baf55e0c52da3be09190d7dc13e5e939180b67e8747",
"md5": "03bb6bfc0eeaafa64f558103aff71964",
"sha256": "0f12551af6605d19f64b9261d4a8e4f573a8299bc838cde00074b37ab1f6ab8f"
},
"downloads": -1,
"filename": "robottrace-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "03bb6bfc0eeaafa64f558103aff71964",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14724,
"upload_time": "2024-07-30T13:48:23",
"upload_time_iso_8601": "2024-07-30T13:48:23.395146Z",
"url": "https://files.pythonhosted.org/packages/a1/5b/814a57444137292a1baf55e0c52da3be09190d7dc13e5e939180b67e8747/robottrace-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-30 13:48:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gorefbitim",
"github_project": "robottrace",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "robottrace"
}
JSON
