✈️ Travel agent bot

This bot will help you organise and plan your travels.

Link: @itq_travel_agent_bot

ER Diagram

live preview

⚙️ Technologies

Python

Python is used successfully in thousands of real-world business applications around the world, including many large and mission critical systems.

Version: 3.12

aiogram

aiogram is a modern and fully asynchronous framework for Telegram Bot API using asyncio and aiohttp.

Version: 3.4

SQLAlchemy

SQLAlchemy is the Python SQL toolkit and Object Relational Mapper that gives application developers the full power and flexibility of SQL.

It provides a full suite of well known enterprise-level persistence patterns, designed for efficient and high-performing database access, adapted into a simple and Pythonic domain language.

Version: 2

PostgreSQL

PostgreSQL is a powerful, open source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.

In project used as the main database.

Version: 16.2

Redis

The in-memory data store used by millions of developers as a cache, vector database, document database, streaming engine, and message broker.

In project redis used as storage for states.

Version: 7.2

🤝 Integrations

OpenStreetMap API

OpenStreetMap is built by a community of mappers that contribute and maintain data about roads, trails, cafés, railway stations, and much more, all over the world.

In the project, the interaction with OpenStreetMap API is implemented using geopy lib.

GraphHopper

Service for conveniently building routes between points on the map. The user can view the route of a trip through webview that appears when clicking on the inline button.

OpenTripMap API

This API used to get nearby sights for location.

Open Weather Map API

API to easily get current weather in specified location.

🖥️ Demonstration

Registration

The first step is, of cource, registration. User needs to fill in some information about himself before using the bot:

1. Username* - used to indeficate users and for interacting between users.
2. Age* - age of user
3. Sex*
4. Bio - Short info about yourself
5. Location* - City and country where user lives
6. Date joined - Fills automaticly

* - required

Profile

User can edit and view it's profile anytime.

Travels creation and editing

User can create, view, edit and delete travel:

1. Title* - title of travel, ex: Anapa 2010
2. Description - description of travel, could be None

* - required

Locations creation and editing

User can create and delete locations

1. Location*
2. Date start* - Start of an activity in location(in UTC)
3. Date end* - End of an activity in location(in UTC)

* - required

Planning routes

User can plan routes between locations he specified

Notes creation and editing

User can create note(it could be file or photo) and edit it

Getting nearby sights and weather of location

User can get location nearby sights(in 2 km radius) and get detailed description of sight. Alsoo user can get current weather in location

There are also lots of small features and cool things that could be discovered while using the bot

🛠️ Local development & testing

Clone repository with git

git clone https://github.com/devitq/Travel-Agent

Navigate to the project directory

cd Travel-Agent

Create virtual enviroment & activate it

Windows

python -m venv venv
venv\Scripts\activate

Linux

python -m venv venv
source venv/bin/activate

Install dev requirements

pip install -r requirements/dev.txt

Setup .env file

Windows

copy template.env .env

Linux

cp template.env .env

And replace all default values with actual values

Generate new migrations(if needed)

alembic -c app/alembic.ini revision --autogenerate

Apply migrations with alembic

alembic -c app/alembic.ini upgrade head

Run bot in development mode

python -m app

🚀 Deploying

Our app uses docker compose for production deployment.

Structure:

travel_agent /
    postgres (starts at 5432 port in your local network)
    redis (starts at 6379 port in your local network)
    app
    pgadmin (starts at 5050 port in your local network)

Clone repository with git

git clone https://github.com/devitq/Travel-Agent

Navigate to the project directory

cd Travel-Agent

Setup .env file

Windows

copy template.env .env

Linux

cp template.env .env

And replace all default values with actual values

Pull actual docker images

docker compose pull

Start containers (in detached mode)

docker compose up -d --build