🚀 VBB Telegram Bot

Your Personal Journey Companion via VBB API

🌟 Description

The VBB Telegram Bot helps in everyday journey planning and updates. Receive real-time information on your trips and get notified instantly if a journey is cancelled. Project works thanks to https://v6.vbb.transport.rest/ VBB API Wrapper

🔧 Usage Features

• 🕒 Next Departures: Quickly find the next departures at nearby stops.
• 🛤️ Detailed Journey Info: Access comprehensive journey details to your favorite addresses.
• 🗺️ Address Management: Easily manage your address database.
• 📍 Geolocation Parsing: Send geolocation point in Telegram to get stops nearby.

💻 Tech Features

• 🗄️ Async PostgreSQL Database: Securely stores addresses and user preferences (via SQLAlchemy).
• 🐳 Docker Virtualization: Provides containerization for both the app and the database.
• 🕰️ Background Service: Sends users journey updates every morning.
• 🎨 User Interface: Smooth and intuitive UI powered by aiogram-dialog.

🚀 Getting Started

• 📄 Add your configuration details in config.toml

📦 Manual Installation

1. Create a new virtual environment

   python -m venv .venv

2. Activate the virtual environment

   • Windows:

     ./.venv/Scripts/activate.ps1

   • Linux/MacOS:

     source .venv/bin/activate 

3. Install all dependencies

   pip install -r requirements.txt

4. Run the bot

   python -m app

🐳 Docker

1. Build and start the services

   docker-compose up --build

📅 Future Plans

• 🧹 Code Cleanup: Remove redundant and unnecessary code (primarily dialogs and message builders).
• 🤖 Improve automatisation