https://github.com/avivace/misterino
Telegram Bot to subscribe and deliver notifications from Twitch Webhooks
https://github.com/avivace/misterino
polling telegram telegram-bot twitch twitch-api twitch-api-new twitchtv webhook webhook-listener webhooks
Last synced: 7 months ago
JSON representation
Telegram Bot to subscribe and deliver notifications from Twitch Webhooks
- Host: GitHub
- URL: https://github.com/avivace/misterino
- Owner: avivace
- License: gpl-3.0
- Created: 2018-09-10T19:08:15.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-05T08:58:26.000Z (almost 7 years ago)
- Last Synced: 2025-02-28T23:50:54.576Z (8 months ago)
- Topics: polling, telegram, telegram-bot, twitch, twitch-api, twitch-api-new, twitchtv, webhook, webhook-listener, webhooks
- Language: Python
- Homepage:
- Size: 108 KB
- Stars: 4
- Watchers: 5
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
> Developed by [Denni Bevilacqua](https://github.com/dennib) and [Antonio Vivace](https://github.com/avivace).
Telegram bot notifying when your favorite streamers go live on Twitch.tv. Users can subscribe to Twitch streamers and receive a message when they go online (privately or in a group).
The telegram bot can function in `polling` or in `webhook` mode. Those modes are idem-potent and you *should* see the same results and behaviours.
### Stack
We make use of
- [_New_ Twitch API](https://dev.twitch.tv/docs/api/reference/);
- [Twitch Webhooks](https://dev.twitch.tv/docs/api/webhooks-reference/) to subscribe to events instead of polling for them.
- [Flask](http://flask.pocoo.org/docs/1.0/api/) as webhook listener;
- [SQLite3](https://www.sqlite.org/docs.html) for persistence and multi-user experience;
- [python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot);
#### Webhook mode
The bot was developed to operate in `webhook` mode (this is also why it _may_ seem over-engineered). Please understand that this requires additional work and maintenance. You need:
- A public IP address and/or domain;
- A SSL certificate;
- A webhook listener;
- A reverse proxy exposing the webhook listener, handling TLS1.0+ HTTPS-traffic.
We don't use the python-telegram-bot integrated webserver, but we listen for webhooks with Flask, then we dispatch the de-jsonified (is this even a word?) payloads to another thread, using a shared Queue.
During development, we use the polling mode to get the payload from messages sent to the bot, then pipe them to `webhookTest.sh` to simulate the Telegram server sending webhook to our listener.
FYI the Twitch events are received anyway listening for webhooks, the `mode` setting changes only the telegram bot operating mode. You don't need all the mentioned things for Twitch because it doesn't require an https enabled endpoint: as long as you have DMZ/open ports you are able to set your own IP as _callback_ for the webhook subscriptions.
### Get started
```bash
# System dependencies
apt install python3 python3-pip
# Get things ready
git clone git@github.com:avivace/misterino.git
cd misterino
python3 -m venv .
source bin/activate
# Python dependencies
pip3 install -r requirements.txt
```
You need a Telegram bot token (use [BotFather](https://t.me/BotFather)), a Twitch Client ID and a Twitch Client Secret (register an application on the [Twitch dev portal](https://dev.twitch.tv/dashboard/apps/create)).
Create a `config.json` with the mentioned values:
```json
{
"mode": "polling",
"botToken": "TELGRAM_BOT_TOKEN",
"TwitchAppClientID": "TWITCH_APP_CLIENT_ID",
"TwitchAppClientSecret": "TWITCH_APP_CLIENT_SECRET"
}
```
Start the bot
```bash
python3 main.py
```
If the script can't find `config.json`, it'll create a default one for you.
You can specify the configuration file to use using `python3 main.py -c config2.json`.
Bot is up and running, talk to it on Telegram.