{"id":17290962,"url":"https://github.com/jchristgit/twitchup","last_synced_at":"2025-07-24T23:41:43.324Z","repository":{"id":97512349,"uuid":"132796073","full_name":"jchristgit/twitchup","owner":"jchristgit","description":"Add Twitch streamers statuses to your subreddit's sidebar.","archived":false,"fork":false,"pushed_at":"2024-11-01T01:38:41.000Z","size":77,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T18:55:08.937Z","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":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jchristgit.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,"publiccode":null,"codemeta":null}},"created_at":"2018-05-09T18:12:43.000Z","updated_at":"2023-04-20T22:34:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"a828d768-e8f9-4a65-8f1a-1eb2159ae3ab","html_url":"https://github.com/jchristgit/twitchup","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/jchristgit/twitchup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jchristgit%2Ftwitchup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jchristgit%2Ftwitchup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jchristgit%2Ftwitchup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jchristgit%2Ftwitchup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jchristgit","download_url":"https://codeload.github.com/jchristgit/twitchup/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jchristgit%2Ftwitchup/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266923038,"owners_count":24006996,"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","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-10-15T10:39:31.974Z","updated_at":"2025-07-24T23:41:43.078Z","avatar_url":"https://github.com/jchristgit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# twitchup\n\n`twitchup` adds Twitch stream status indicators for subreddit sidebars. It\nworks by polling stream information from Twitch's API and then updating a given\nsidebar template.\n\n## Setup\n\nSet the following environment variables:\n- `REDDIT_CLIENT_ID`: your reddit bot client ID\n- `REDDIT_CLIENT_SECRET`: your reddit bot client secret\n- `REDDIT_USERNAME` and `REDDIT_PASSWORD` for the bot account\n- `TWITCH_CLIENT_ID`: your twitch app client ID (get it\n  [here](https://dev.twitch.tv/dashboard/apps))\n- `OWNER_NAME`: the name of the bot's owner on reddit, without the leading `/u/`\n  part.\n\nYou can get the reddit credentials [here](https://www.reddit.com/prefs/apps/).\nMake sure to add the bot as a moderator on the specific subreddit.\n\nInstall dependencies: `pip3 install -r requirements.txt`. Or `apt install\npython3-praw` on a Debian-based system.\n\n## Usage\n\nCreate a directory named `templates` (or any place of your liking, as specified\nby the `--template-directory` switch) and create subdirectories named after the\ndesired subreddits in there. To template a custom or text area widget with the\ntitle \"Streams\", create a file named `widget.md` in said subdirectory. For\ntemplating the old-style sidebar, create a file named `sidebar.md` instead. You\ncan also create both files. Use `twitchup(\u003cstream_name\u003e)` where you want stream\ninformation to be placed.  `twitchup` generates the following:\n\nFor an online stream, `twitchup(name)` becomes:\n```md\n[name](https://twitch.tv/name 'twitch-online')\n```\nand for an offline stream, `twitchup(name)` becomes:\n```md\n[name](https://twitch.tv/name 'twitch-offline')\n```\n\nYou can then apply custom styles in your subreddit's stylesheet.\n\nTo run the script, simply use `python3 twitchup.py`.\n\n\n## Disclaimer\n`twitchup` is not affiliated nor endorsed by Twitch or Reddit.\n\n## Credits\n`twitchup` is inspired by [`twitchit`](https://github.com/jensechu/twitchit).\n\n\n\u003c!-- vim: set textwidth=80 sw=2 ts=2: --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjchristgit%2Ftwitchup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjchristgit%2Ftwitchup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjchristgit%2Ftwitchup/lists"}