https://github.com/perchunpak/twitch-stream-notifier
Script to send notification when someone is starts streaming on Twitch.
https://github.com/perchunpak/twitch-stream-notifier
Last synced: about 1 year ago
JSON representation
Script to send notification when someone is starts streaming on Twitch.
- Host: GitHub
- URL: https://github.com/perchunpak/twitch-stream-notifier
- Owner: PerchunPak
- License: mit
- Created: 2024-02-01T21:20:06.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-24T23:59:29.000Z (over 2 years ago)
- Last Synced: 2024-03-25T00:34:29.228Z (over 2 years ago)
- Language: Python
- Size: 488 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# twitch-stream-notifier
[](https://www.gov.uk/government/news/ukraine-what-you-can-do-to-help)
[](https://github.com/PerchunPak/twitch-stream-notifier/actions?query=workflow%3Atest)
[](https://github.com/psf/black)
[](https://www.python.org/downloads/)
Script to send notification when someone starts streaming on Twitch.
## How to use
```bash
docker run -d \
-v /path/to/data:/app/data \
--restart=unless-stopped \
perchunpak/twitch-stream-notifier:latest
```
Then go to data folder and edit `config.yml` file.
- `check_interval_minutes`: interval between checks for new streams in minutes (if you get rate limited, increase this number).
- `telegram_token`: Telegram bot token which will send you notifications.
- `notify_on_stream_end`: whether to send notification when stream ends.
- `twitch_usernames`: list of streamers to check for.
- `telegram_chat_ids`: list of user IDs to send notifications for (write to [@userinfobot](https://t.me/userinfobot) to get your ID).
- `apykuma`: settings for [apykuma](https://pypi.com/project/apykuma/), if you don't know what is it - don't touch it.
- `sentry`: settings for [Sentry](https://sentry.io), if you don't know what is it - don't touch it.
- `logging`: settings for logging, keep as it is, only useful for debugging.
Note that to apply changes, you need to restart the app.
## Installing for local developing
```bash
git clone https://github.com/PerchunPak/twitch-stream-notifier.git
cd twitch-stream-notifier
```
### Installing `poetry`
Next we need install `poetry` with [recommended way](https://python-poetry.org/docs/master/#installation).
If you use Linux, use command:
```bash
curl -sSL https://install.python-poetry.org | python -
```
If you use Windows, open PowerShell with admin privileges and use:
```powershell
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -
```
### Installing dependencies
```bash
poetry install --no-dev
```
### If something is not clear
You can always write to me!
## Thanks
This project was generated with [python-template](https://github.com/PerchunPak/python-template).
Code to check for Twitch stream was copied from https://stackoverflow.com/a/71289342.