mirror of
https://github.com/driftywinds/twitchrise.git
synced 2025-12-18 19:13:16 +00:00
Twitchrise - Apprise Notifications for Twitch Channels
Stay up to date with your favourite Twitch channels going live (or offline).
Important
There is a Telegram Bot version of Twitchrise geared for multiple users and multiple apprise endpoints that can be found here. If you want to run Twitchrise for a group of friends or family, this would be the easy and friendly way to do so over Telegram.
Also available on Docker Hub - driftywinds/twitchrise:latest
How to use: -
- Download the
compose.ymland.envfiles from the repo here. - Go to https://dev.twitch.tv/console and register a new application. You can name it anything, but the client type should be
confidential, that will give you a client ID and client secret. - Customise the
.envfile (you can see the endpoints Apprise supports and their config URLs here) and use the client ID and client secret from above. - Run
docker compose up -d.
You can check logs live with this command: -
docker compose logs -f
For dev testing: -
- have python3 installed on your machine
- clone the repo
- go into the directory and run these commands: -
python3 -m venv .venv
source .venv/bin/activate
pip install --no-cache-dir -r requirements.txt
- configure
.envvariables. - then run
python3 head.py
Languages
Python
94.4%
Dockerfile
5.6%