{"id":19115371,"url":"https://github.com/perchunpak/twitch-stream-notifier","last_synced_at":"2025-04-19T00:32:48.395Z","repository":{"id":220407190,"uuid":"751563970","full_name":"PerchunPak/twitch-stream-notifier","owner":"PerchunPak","description":"Script to send notification when someone is starts streaming on Twitch.","archived":false,"fork":false,"pushed_at":"2024-03-24T23:59:29.000Z","size":500,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-03-25T00:34:29.228Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PerchunPak.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-02-01T21:20:06.000Z","updated_at":"2024-02-01T21:20:17.000Z","dependencies_parsed_at":"2024-03-11T00:36:18.161Z","dependency_job_id":"65859134-bdcd-49da-a4b4-13d810726a30","html_url":"https://github.com/PerchunPak/twitch-stream-notifier","commit_stats":null,"previous_names":["perchunpak/twitch-stream-notifier"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PerchunPak%2Ftwitch-stream-notifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PerchunPak%2Ftwitch-stream-notifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PerchunPak%2Ftwitch-stream-notifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PerchunPak%2Ftwitch-stream-notifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PerchunPak","download_url":"https://codeload.github.com/PerchunPak/twitch-stream-notifier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223786798,"owners_count":17202603,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T04:46:13.335Z","updated_at":"2024-11-09T04:46:13.788Z","avatar_url":"https://github.com/PerchunPak.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# twitch-stream-notifier\n\n[![Support Ukraine](https://badgen.net/badge/support/UKRAINE/?color=0057B8\u0026labelColor=FFD700)](https://www.gov.uk/government/news/ukraine-what-you-can-do-to-help)\n\n[![Build Status](https://github.com/PerchunPak/twitch-stream-notifier/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/PerchunPak/twitch-stream-notifier/actions?query=workflow%3Atest)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Python support versions badge](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)](https://www.python.org/downloads/)\n\nScript to send notification when someone starts streaming on Twitch.\n\n## How to use\n\n```bash\ndocker run -d \\\n  -v /path/to/data:/app/data \\\n  --restart=unless-stopped \\\n  perchunpak/twitch-stream-notifier:latest\n```\n\nThen go to data folder and edit `config.yml` file.\n\n- `check_interval_minutes`: interval between checks for new streams in minutes (if you get rate limited, increase this number).\n- `telegram_token`: Telegram bot token which will send you notifications.\n- `notify_on_stream_end`: whether to send notification when stream ends.\n- `twitch_usernames`: list of streamers to check for.\n- `telegram_chat_ids`: list of user IDs to send notifications for (write to [@userinfobot](https://t.me/userinfobot) to get your ID).\n- `apykuma`: settings for [apykuma](https://pypi.com/project/apykuma/), if you don't know what is it - don't touch it.\n- `sentry`: settings for [Sentry](https://sentry.io), if you don't know what is it - don't touch it.\n- `logging`: settings for logging, keep as it is, only useful for debugging.\n\nNote that to apply changes, you need to restart the app.\n\n## Installing for local developing\n\n```bash\ngit clone https://github.com/PerchunPak/twitch-stream-notifier.git\ncd twitch-stream-notifier\n```\n\n### Installing `poetry`\n\nNext we need install `poetry` with [recommended way](https://python-poetry.org/docs/master/#installation).\n\nIf you use Linux, use command:\n\n```bash\ncurl -sSL https://install.python-poetry.org | python -\n```\n\nIf you use Windows, open PowerShell with admin privileges and use:\n\n```powershell\n(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -\n```\n\n### Installing dependencies\n\n```bash\npoetry install --no-dev\n```\n\n### If something is not clear\n\nYou can always write to me!\n\n## Thanks\n\nThis project was generated with [python-template](https://github.com/PerchunPak/python-template).\n\nCode to check for Twitch stream was copied from https://stackoverflow.com/a/71289342.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperchunpak%2Ftwitch-stream-notifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fperchunpak%2Ftwitch-stream-notifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperchunpak%2Ftwitch-stream-notifier/lists"}