No Description

dependabot[bot] 4e8da25442 build(deps-dev): bump black from 24.1.1 to 24.2.0		8 months ago
.github	fccdd10436 build(deps): bump actions/setup-python from 4 to 5	10 months ago
docs	225189d547 readme: added screenshots	3 years ago
location_guessing_game_telegram_bot	2dfe315541 upgrade black from 23.12.1 to 24.1.1	9 months ago
tests	d551dd42bd pylint: enable various optional checks/extensions	2 years ago
.dockerignore	a1015b3d7f support image build without git history (fixes github action)	3 years ago
.gitignore	fa44f5ac67 added gitignore list	3 years ago
.pylintrc	d551dd42bd pylint: enable various optional checks/extensions	2 years ago
CHANGELOG.md	6b1b7e1f3e drop compatibility with python3.7 (reached end of life on 2023-06-27)	1 year ago
COPYING	ca0541b65c added GPLv3+	3 years ago
Dockerfile	0e63d85627 container image: upgrade base image to debian bullseye with python3.10.0	3 years ago
Makefile	ca0541b65c added GPLv3+	3 years ago
Pipfile	fb164b87d4 relock env with pipenv v2023.10.3 on python v3.11.2 (to remove sanitized-package entry, see commit below); remove pylint-import-requirements from pipeline (see commit below)	1 year ago
Pipfile.lock	4e8da25442 build(deps-dev): bump black from 24.1.1 to 24.2.0	8 months ago
README.md	225189d547 readme: added screenshots	3 years ago
ansible-playbook-example.yml	7e12a91a6d added sample playbook	3 years ago
docker-compose.yml	bded47d485 setup docker-compose	3 years ago
mypy.ini	d488c3918b mypy: ignore imports of python-telegram-bot	3 years ago
pyproject.toml	558bb9bc90 configure python package; added readme	3 years ago
setup.py	6b1b7e1f3e drop compatibility with python3.7 (reached end of life on 2023-06-27)	1 year ago

Location Guessing Game Telegram Bot 🏞️ 🌍 📌

Basic Telegram Bot Sending Random Wikimedia Commons Photos

Setup

Download a dataset of photos via the WikiMap API, for instance:

wget --restrict-file-names=windows 'https://wikimap.toolforge.org/api.php?cat=Images_with_annotations&lang=de&year=2010-2015&region=49|9|46|18'

Generate a bot API token by sending /newbot to BotFather
Install bot via pip3 install --user --upgrade location-guessing-game-telegram-bot (or use docker / podman, see below)

Usage

Launch bot: location-guessing-game-telegram-bot --telegram-token-path file-containing-api-token --wikimap-export-path wikimap-export.json
Open a chat with the bot in Telegram by searching for the bot's name previously sent to BotFather
Send message /photo, wait, and repeat
Optionally add the bot to a group chat.

Docker / Podman 🐳

Pre-built docker images are available at https://hub.docker.com/r/fphammerle/location-guessing-game-telegram-bot/tags

$ sudo docker run --name location_guessing_game_telegram_bot \
    -v /file/containing/api-token:/telegram-token:ro -e TELEGRAM_TOKEN_PATH=/telegram-token \
    -v /wikimap/export.json:/wikimap-export.json:ro -e WIKIMAP_EXPORT_PATH=/wikimap-export.json \
    --read-only --cap-drop ALL --security-opt no-new-privileges \
    --cpus 0.4 --memory 128M \
    docker.io/fphammerle/location-guessing-game-telegram-bot:latest

Optionally, replace sudo docker with podman.

Annotation of signed git tags docker/* contains docker image digests: https://github.com/fphammerle/location-guessing-game-telegram-bot/tags

Detached signatures of images are available at https://github.com/fphammerle/container-image-sigstore (exluding automatically built latest tag).

Docker Compose 🐙

Clone this repository.
Edit paths in docker-compose.yml.
sudo docker-compose up --build

Ansible

See ansible-playbook-example.yml.

Trivia

Why create a Telegram bot instead of a web app?

I created this mini game for my family including my grandparents, who are comfortable using Telegram.

README.md