{"id":37229075,"url":"https://github.com/jcaet/boardgame-search-telegram-bot","last_synced_at":"2026-04-14T12:01:19.230Z","repository":{"id":331903875,"uuid":"1126369911","full_name":"JCaet/boardgame-search-telegram-bot","owner":"JCaet","description":"A Telegram bot that allows users to search for Boardgames and quickly link to them","archived":false,"fork":false,"pushed_at":"2026-04-13T16:25:25.000Z","size":1289,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-13T18:23:59.579Z","etag":null,"topics":["bgg","board-game","boardgame","boardgamegeek","telegram","telegrambot"],"latest_commit_sha":null,"homepage":"","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/JCaet.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-01T19:06:21.000Z","updated_at":"2026-04-13T16:23:18.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/JCaet/boardgame-search-telegram-bot","commit_stats":null,"previous_names":["jcaet/boardgame-search-telegram-bot"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/JCaet/boardgame-search-telegram-bot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JCaet%2Fboardgame-search-telegram-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JCaet%2Fboardgame-search-telegram-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JCaet%2Fboardgame-search-telegram-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JCaet%2Fboardgame-search-telegram-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JCaet","download_url":"https://codeload.github.com/JCaet/boardgame-search-telegram-bot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JCaet%2Fboardgame-search-telegram-bot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31795334,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-14T11:13:53.975Z","status":"ssl_error","status_checked_at":"2026-04-14T11:13:53.299Z","response_time":153,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["bgg","board-game","boardgame","boardgamegeek","telegram","telegrambot"],"created_at":"2026-01-15T03:31:02.282Z","updated_at":"2026-04-14T12:01:19.223Z","avatar_url":"https://github.com/JCaet.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Board Game Search Telegram Bot\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n\nA Telegram bot that allows users to search for board games on [BoardGameGeek](https://boardgamegeek.com) and quickly share them in chats using inline queries.\n\n## Features\n\n- 🔍 **Inline Search**: Type `@botname \u003cgame\u003e` in any chat to search BoardGameGeek\n- 🖼️ **Thumbnails**: See game images in search results  \n- 🔗 **Quick Share**: Tap a result to share a formatted link\n\n## Prerequisites\n\n- Python 3.12+\n- [uv](https://docs.astral.sh/uv/) package manager\n- Telegram Bot Token (from [@BotFather](https://t.me/BotFather))\n- BGG API Key (register at BoardGameGeek)\n\n## Installation\n\n```bash\n# Clone the repository\ngit clone https://github.com/yourusername/boardgame-search-telegram-bot.git\ncd boardgame-search-telegram-bot\n\n# Install dependencies\nuv sync\n\n# Copy environment template and fill in your credentials\ncp .env.example .env\n```\n\n## Configuration\n\nEdit `.env` with your credentials:\n\n```env\n# Required\nTELEGRAM_BOT_TOKEN=your_telegram_bot_token_here\nBGG_API_KEY=your_bgg_api_key_here\n\n# For webhook mode (Cloud Run deployment)\nWEBHOOK_URL=https://your-service.run.app\nWEBHOOK_SECRET=your_generated_secret  # Recommended for security\n```\n\n| Variable | Required | Description |\n|----------|----------|-------------|\n| `TELEGRAM_BOT_TOKEN` | Yes | Bot token from [@BotFather](https://t.me/BotFather) |\n| `BGG_API_KEY` | Yes | BoardGameGeek API key |\n| `WEBHOOK_URL` | No* | Your Cloud Run service URL (*required for webhook mode) |\n| `WEBHOOK_SECRET` | No | Secret token for webhook verification (recommended) |\n| `PORT` | No | Webhook server port (default: 8080, auto-set by Cloud Run) |\n\nGenerate a webhook secret with:\n```bash\npython -c \"import secrets; print(secrets.token_urlsafe(32))\"\n```\n\n## Usage\n\n```bash\n# Run the bot (polling mode)\nuv run main.py\n```\n\nThen in Telegram, type `@yourbotname Catan` in any chat to search for games.\n\n## Cloud Run Deployment\n\nThe bot can be deployed to Google Cloud Run using the included GitHub Actions workflow.\n\n### Required GitHub Secrets\n\n| Secret | Description |\n|--------|-------------|\n| `GCP_PROJECT_ID` | Your Google Cloud project ID |\n| `GCP_CREDENTIALS` | Service account JSON key with Cloud Run permissions |\n| `TELEGRAM_BOT_TOKEN` | Your Telegram bot token |\n| `BGG_API_KEY` | Your BoardGameGeek API key |\n| `WEBHOOK_URL` | Your Cloud Run service URL (e.g., `https://boardgame-search-bot-xxx-uc.a.run.app`) |\n| `WEBHOOK_SECRET` | Generated secret for webhook verification |\n\nThe deployment is triggered automatically on successful releases or manually via workflow dispatch.\n\n\n## Development\n\n```bash\n# Install dev dependencies\nuv sync --group dev\n\n# Run linter\nuv run ruff check .\n\n# Run tests\nuv run pytest\n\n# Run tests with coverage\nuv run pytest --cov\n\n# Install pre-commit hooks\nuv run pre-commit install\nuv run pre-commit install --hook-type commit-msg\n```\n\n## Docker\n\n```bash\n# Build\ndocker build -t boardgame-search-bot .\n\n# Run\ndocker run -d --env-file .env boardgame-search-bot\n```\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcaet%2Fboardgame-search-telegram-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjcaet%2Fboardgame-search-telegram-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcaet%2Fboardgame-search-telegram-bot/lists"}