https://github.com/david-lor/vigobus-telegrambot
Bot de Telegram para ver los horarios de los autobuses de Vigo por paradas 🤖🚌🚏
https://github.com/david-lor/vigobus-telegrambot
aiogram async asyncio autobuses bus bus-stop python python3 python3-7 python36 python37 telebot telegram telegram-bot vigo vigobus-telegrambot vitrasa
Last synced: 7 months ago
JSON representation
Bot de Telegram para ver los horarios de los autobuses de Vigo por paradas 🤖🚌🚏
- Host: GitHub
- URL: https://github.com/david-lor/vigobus-telegrambot
- Owner: David-Lor
- License: apache-2.0
- Created: 2017-09-27T14:12:56.000Z (about 8 years ago)
- Default Branch: develop
- Last Pushed: 2024-09-04T00:14:25.000Z (about 1 year ago)
- Last Synced: 2025-04-26T10:17:41.708Z (7 months ago)
- Topics: aiogram, async, asyncio, autobuses, bus, bus-stop, python, python3, python3-7, python36, python37, telebot, telegram, telegram-bot, vigo, vigobus-telegrambot, vitrasa
- Language: Python
- Homepage:
- Size: 463 KB
- Stars: 11
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# VigoBus-TelegramBot
[](https://telegram.me/vigobusbot)
[](https://telegram.me/vigobustestbot)
Telegram Bot that serves bus stops and real-time estimated time of arrival for the buses of the city of Vigo.
_Bot de Telegram que permite consultar las paradas y autobuses que se dirigen a las mismas -junto a su tiempo restante de llegada, en tiempo real-, en la red de transporte urbano de la ciudad de Vigo._
## Microservice structure
- VigoBusTelegramBot: this project, serving as the Telegram Bot backend, and connecting to the following API:
- VigoBusAPI: REST API to fetch stop & real-time estimated time of buses arrival
- Persistence API: REST API to persist data
- MongoDB: used by both REST API to persist data - and for bot requests logs persistence
## Requirements
- Python >= 3.9
- [VigoBusAPI](https://github.com/David-Lor/Python_VigoBusAPI)
- [DataManager (Persistence API)](https://github.com/David-Lor/Telegram-BusBot-DataManager)
- requirements listed in [requirements.txt](requirements.txt)
- A Telegram bot created with BotFather
- For Inline mode: enable Inline Mode and set Inline Feedback to 100% on Bot Settings
- A MongoDB database (for both required API - and requests log persistence)
### Deployment
- Docker recommended for deployment using the [Docker Python Git App](https://github.com/David-Lor/Docker-Python-Git-App) image
- Refer to [docker-compose.yml](tools/deployment/vigobusbot) file to deploy all the required services (deploying as-is requires Docker Compose >= 1.27.4)
## Changelog
- 2.6.0
- update deprecated Stop messages with a warning
- include calculated arrival time (HH:MM) on buses
- avoid logging warnings on 404 HTTP responses
- allow loading settings from an arbitrary env file specified by the ENV_FILE env var
- upgrade requirements versions
- 2.5.1
- fix error handling for HTTP timeouts
- return the request id on error messages (only normal messages, not inline replies)
- support for self-hosted Telegram Bot API
- 2.5.0
- allow searching stops by name without command
- upgrade requirements versions
- refactor deployment docker-compose example
- 2.4.1
- fix wrong characters from API responses due to bad encoding (switch from `json.loads(response.text)` to `response.json()`)
- fix/improve request error handling: log exceptions, improve logging
- 2.4.0
- search stop by id through inline mode
- limit stop search results to 50 (Telegram Bot API limit for inline query results)
- 2.3.0
- add request logs persistence in MongoDB
- 2.2.0
- search stops by name (command & inline mode)
- 2.1.0
- send bot commands list to Telegram programmatically
- improve logging
- 2.0.2
- delete original message with ForceReply markup after user sends its Feedback message
- 2.0.1
- refactor message generators
- refactor HTTP requester functions, merging in one service
- 2.0.0
- refactor Telegram Bot request services/helpers
- 1.2.1
- remove dotenv-settings-handler in favor of pydantic only
- 1.2.0
- add one-way feedback communication system (adding "admin_userid" setting)
- fix error when renaming stop after forcereply timeout (TTL)
- rename Telegram setting "stop_rename_request_ttl" to "force_reply_ttl"
- 1.1.1
- fix encoding on extracted user data (saved stops) on JSON file
- 1.1.0
- extract user data (saved stops) into JSON file
- delete all persisted user data (saved stops)
- change Markdown for HTML, to avoid errors when including markdown characters in text (such as underscore)
- 1.0.0
- **(breaking change @ Mongo/Persistence API)** encode/decode saved user stop data into/from Persistence API
- fix "task exception was never retrieved" warning on aiogram error handler
- add support for loading bot token from a secrets file
- add request id as part of the logging context
- fix stop remove name
- remove usage of external pybusent library in favor of self-defined classes
- sort user saved stops by stop custom or real name
- fix stop rename failing
- 0.1.6
- add logging
- 0.1.5:
- fix stop rename crashing
- add error handler for uncatched global, generic exceptions
- switch from requests_async to httpx
- add retries on HTTP requests
- add user request rate limit (amount per time)
- 0.1.4
- button on Stop messages to show More/Less buses
- 0.1.3
- support for setting custom stop names on user saved stops
- 0.1.2
- support for Saved Stops and working command to list all of them
- 0.1.1
- inline keyboard markup with callback support for Refreshing Stop messages
- 0.1.0
- initial async version (basic Get Stop messages)
## Disclaimer
This project is not endorsed by, directly affiliated with, maintained by, sponsored by or in any way officially related with the company, companies and/or entities responsible for the public transport service of the city of Vigo.
_Este proyecto no cuenta con soporte de, no está afiliado con, mantenido por, patrocinado por ni en cualquier otra manera oficialmente vinculado con la compañía, compañías y/o entidades responsables del sistema de transporte público de la ciudad de Vigo._