{"id":22080556,"url":"https://github.com/electronic-mango/justwatch-telegram-bot","last_synced_at":"2025-03-23T20:45:25.602Z","repository":{"id":206883474,"uuid":"717865338","full_name":"Electronic-Mango/justwatch-telegram-bot","owner":"Electronic-Mango","description":"Simple JustWatch Telegram bot.","archived":false,"fork":false,"pushed_at":"2024-06-15T14:52:54.000Z","size":56,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-06-15T15:46:59.222Z","etag":null,"topics":["bot","justwatch","python","python-telegram-bot","python3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Electronic-Mango.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2023-11-12T20:44:37.000Z","updated_at":"2024-06-15T14:52:58.000Z","dependencies_parsed_at":"2024-06-15T15:43:09.719Z","dependency_job_id":"cf839a07-4f17-4d15-a3dd-89f5e26ed47b","html_url":"https://github.com/Electronic-Mango/justwatch-telegram-bot","commit_stats":null,"previous_names":["electronic-mango/justwatch-telegram-bot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Electronic-Mango%2Fjustwatch-telegram-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Electronic-Mango%2Fjustwatch-telegram-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Electronic-Mango%2Fjustwatch-telegram-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Electronic-Mango%2Fjustwatch-telegram-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Electronic-Mango","download_url":"https://codeload.github.com/Electronic-Mango/justwatch-telegram-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245168808,"owners_count":20571799,"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":["bot","justwatch","python","python-telegram-bot","python3"],"created_at":"2024-11-30T23:15:40.432Z","updated_at":"2025-03-23T20:45:25.578Z","avatar_url":"https://github.com/Electronic-Mango.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JustWatch Telegram bot\n\nAn unofficial and simple [JustWatch](https://www.justwatch.com/) Telegram bot.\nIt's built using `Python 3.11`, [`python-telegram-bot`](https://python-telegram-bot.org/) and my [simple-justwatch-python-api](https://github.com/Electronic-Mango/simple-justwatch-python-api/).\n\n\n\n## Requirements\n\nFull list of Python requirements is in `requirements.txt` file.\n\n\n\n## Configuration\n\nBot configuration is done through `.env` file.\n\nThere is 1 mandatory parameters:\n * `TOKEN` - Telegram bot token\n\nThere are also multiple optional parameters:\n * `PERSISTENCE_FILE` - file used for bot command persistence, by default `persistence` in project root is used\n * `ALLOWED_USERNAMES` - list of usernames (separated by space) who can use the bot, if left empty, then bot can be used by everyone\n * `COUNTRY` - configures search country in JustWatch, by default `US` is used\n * `LANGUAGE` - configures search results language, by default `en` is used\n * `COUNT` - configures how many responses bot will print out, by default `4` is used\n\n\n\n## Running the bot\n\nRegardless of whether you want to run the bot via Docker, or manually you need a [Telegram bot and its token](https://core.telegram.org/bots/tutorial).\n\n\n### Docker\n\n**Docker Compose will handle persistence file on its own.**\n\n1. Add `TOKEN` in `.env` file and any other optional parameter, **except `PERSISTENCE_FILE`** if using Docker Compose\n2. Run via Docker Compose: `docker compose up -d --build`\n\n```shell\n# Mandatory\necho \"TOKEN='\u003cTOKEN\u003e'\" \u003e\u003e .env\n\n# Optional\necho \"ALLOWED_USERNAMES='\u003cusernames\u003e'\" \u003e\u003e .env\necho \"COUNTRY='GB'\" \u003e\u003e .env\necho \"LANGUAGE='fr'\" \u003e\u003e .env\necho \"COUNT=5\" \u003e\u003e .env\n\ndocker compose up -d --build\n```\n\n\n### Manually\n\n1. Fill `.env` file\n2. Install all requirements: `pip install -r requirements.txt`\n3. Run main file: `python3.11 main.py`\n\n```shell\necho 'TOKEN=\u003cTOKEN\u003e' \u003e\u003e .env\npip install -r requirements.txt\npython3.11 src/main.py\n```\n\n\n\n## Usage\n\nYou can access help though `/help` or `/start` commands.\n\nOther than that, bot doesn't have any commands, it responds to all messages send to it.\nReceived messages are treated as search queries.\nFor each message bot will respond with a list of found elements in form of selectable items.\nYou can access details for each through them.\n\n\n\n## Disclaimer\n\nThis is an independent and unofficial project.\nUse at your own risk.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectronic-mango%2Fjustwatch-telegram-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felectronic-mango%2Fjustwatch-telegram-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectronic-mango%2Fjustwatch-telegram-bot/lists"}