# keel-telegram-bot [](https://actions-badge.atrox.dev/markusressel/keel-telegram-bot/goto?ref=master) [](https://codeclimate.com/github/markusressel/keel-telegram-bot) [](https://badge.fury.io/py/keel-telegram-bot)
**keel-telegram-bot** is a telegram bot for [Keel](https://keel.sh/).
<p align="center">
<img src="/screenshots/commands.png" width="400"> <img src="/screenshots/approval.png" width="400">
</p>
# Features
* [x] Receive notifications (via Webhook)
* [x] List approvals
* [x] Approve pending approvals
* [x] Reject pending approvals
* [x] Delete archived approvals
* [x] Permission handling based on telegram usernames
* [x] Filter visible approvals on a per-chat basis
# How to use
## Manual installation
### Install
Install **keel-telegram-bot** using pip:
```shell
pip3 install keel-telegram-bot
```
### Configuration
**keel-telegram-bot** uses [container-app-conf](https://github.com/markusressel/container-app-conf)
to provide configuration via a YAML file as well as ENV variables. Have a look at the
[documentation about it](https://github.com/markusressel/container-app-conf).
See [keel-telegram-bot_example.yaml](/keel-telegram-bot_example.yaml) for an example in this repo.
### Run
Start the bot by using:
```shell script
keel-telegram-bot
```
## Docker
To run **keel-telegram-bot** using docker you can use the [markusressel/keel-telegram-bot](https://hub.docker.com/r/markusressel/keel-telegram-bot)
image from DockerHub:
```
sudo docker run -t \
markusressel/keel-telegram-bot:latest
```
Configure the image using either environment variables, or mount the configuration
file from your host system to `/app/keel-telegram-bot.yaml`.
## Setup
This bot uses the REST api provided by Keel to interact with it
and relies on the Webhook functionality to receive and forward notifications
to telegram chats. On one hand **keel-telegram-bot** acts like the web
interface, on the other hand it acts like a proxy, both combined into a
single package.
To get the commands working simply provide all the necessary details of
the configuration file.
To get notifications working you will have to provide the address of
**keel-telegram-bot** to Keel using the `WEBHOOK_ENDPOINT` env variable.
The simplest way to achieve this is by running both Keel and **keel-telegram-bot**
on the same host and specifying `http://localhost:5000/`.
# Contributing
GitHub is for social coding: if you want to write code, I encourage contributions through pull requests from forks
of this repository. Create GitHub tickets for bugs and new features and comment on the ones that you are interested in.
# License
```text
keel-telegram-bot by Markus Ressel
Copyright (C) 2020 Markus Ressel
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/markusressel/keel-telegram-bot",
"name": "keel-telegram-bot",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Markus Ressel",
"author_email": "mail@markusressel.de",
"download_url": "https://files.pythonhosted.org/packages/1e/06/f132d8f96d3fe01caa435a6023e42585111951e181e73e50b2f7946d3513/keel-telegram-bot-1.3.1.tar.gz",
"platform": null,
"description": "# keel-telegram-bot [](https://actions-badge.atrox.dev/markusressel/keel-telegram-bot/goto?ref=master) [](https://codeclimate.com/github/markusressel/keel-telegram-bot) [](https://badge.fury.io/py/keel-telegram-bot)\n\n**keel-telegram-bot** is a telegram bot for [Keel](https://keel.sh/).\n\n\n<p align=\"center\">\n <img src=\"/screenshots/commands.png\" width=\"400\"> <img src=\"/screenshots/approval.png\" width=\"400\"> \n</p>\n\n# Features\n\n* [x] Receive notifications (via Webhook)\n* [x] List approvals\n* [x] Approve pending approvals\n* [x] Reject pending approvals\n* [x] Delete archived approvals\n* [x] Permission handling based on telegram usernames\n* [x] Filter visible approvals on a per-chat basis\n\n# How to use\n\n## Manual installation\n\n### Install\n\nInstall **keel-telegram-bot** using pip:\n\n```shell\npip3 install keel-telegram-bot\n```\n\n### Configuration\n\n**keel-telegram-bot** uses [container-app-conf](https://github.com/markusressel/container-app-conf)\nto provide configuration via a YAML file as well as ENV variables. Have a look at the \n[documentation about it](https://github.com/markusressel/container-app-conf).\n\nSee [keel-telegram-bot_example.yaml](/keel-telegram-bot_example.yaml) for an example in this repo.\n\n### Run\n\nStart the bot by using:\n\n```shell script\nkeel-telegram-bot\n```\n\n## Docker\n\nTo run **keel-telegram-bot** using docker you can use the [markusressel/keel-telegram-bot](https://hub.docker.com/r/markusressel/keel-telegram-bot) \nimage from DockerHub:\n\n```\nsudo docker run -t \\\n markusressel/keel-telegram-bot:latest\n```\n\nConfigure the image using either environment variables, or mount the configuration\nfile from your host system to `/app/keel-telegram-bot.yaml`.\n\n## Setup\n\nThis bot uses the REST api provided by Keel to interact with it\nand relies on the Webhook functionality to receive and forward notifications\nto telegram chats. On one hand **keel-telegram-bot** acts like the web \ninterface, on the other hand it acts like a proxy, both combined into a \nsingle package.\n\nTo get the commands working simply provide all the necessary details of\nthe configuration file.\n\nTo get notifications working you will have to provide the address of \n**keel-telegram-bot** to Keel using the `WEBHOOK_ENDPOINT` env variable.\nThe simplest way to achieve this is by running both Keel and **keel-telegram-bot**\non the same host and specifying `http://localhost:5000/`.\n\n# Contributing\n\nGitHub is for social coding: if you want to write code, I encourage contributions through pull requests from forks\nof this repository. Create GitHub tickets for bugs and new features and comment on the ones that you are interested in.\n\n# License\n\n```text\nkeel-telegram-bot by Markus Ressel\nCopyright (C) 2020 Markus Ressel\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program. If not, see <http://www.gnu.org/licenses/>.\n```\n",
"bugtrack_url": null,
"license": "AGPLv3+",
"summary": "A telegram bot for keel.sh",
"version": "1.3.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0b19fc3b895fa973a077a271e32cbb1d7d9aa78cdfde035e413c7e961d24d5eb",
"md5": "ecfb8a2a9ecc80793c47679b7ea5490f",
"sha256": "138a11562874dd5a37f7a836cf73e2a1d7da6846ad80cce6d1409a3e3cd17ea4"
},
"downloads": -1,
"filename": "keel_telegram_bot-1.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ecfb8a2a9ecc80793c47679b7ea5490f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 34295,
"upload_time": "2023-02-11T23:30:47",
"upload_time_iso_8601": "2023-02-11T23:30:47.120566Z",
"url": "https://files.pythonhosted.org/packages/0b/19/fc3b895fa973a077a271e32cbb1d7d9aa78cdfde035e413c7e961d24d5eb/keel_telegram_bot-1.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1e06f132d8f96d3fe01caa435a6023e42585111951e181e73e50b2f7946d3513",
"md5": "bc570db27f85b21396d21af586b63f5b",
"sha256": "746603b945fbf3ae23742b7984a4363561ed3bce32958fd0ce12516642f2979e"
},
"downloads": -1,
"filename": "keel-telegram-bot-1.3.1.tar.gz",
"has_sig": false,
"md5_digest": "bc570db27f85b21396d21af586b63f5b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 65186,
"upload_time": "2023-02-11T23:30:49",
"upload_time_iso_8601": "2023-02-11T23:30:49.444707Z",
"url": "https://files.pythonhosted.org/packages/1e/06/f132d8f96d3fe01caa435a6023e42585111951e181e73e50b2f7946d3513/keel-telegram-bot-1.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-11 23:30:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "markusressel",
"github_project": "keel-telegram-bot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "keel-telegram-bot"
}
JSON
