Add files via upload

Author: korjeek

Dockerfile

@@ -0,0 +1,5 @@
+FROM python:3.12
+WORKDIR /app
+COPY . /app/
+RUN pip install -r requirements.txt
+ENTRYPOINT python main.py

README.md

@@ -0,0 +1,61 @@
+# Музейный Бот для города Екатеринбурга
+
+Добро пожаловать в **Музейный Бот**, телеграмм-бот, предназначенный для помощи в поиске музеев в городе Екатеринбург. 
+
+Этот бот написан на Python с использованием библиотек `aiogram`, `geopy`, `requests`, `beautifulsoup4`, `SQLAlchemy`.
+Кроме того использованы **Базы Данных** для хранения данных (`PostgreSQL`)
+
+## Особенности
+
+- **Поиск по местоположению**: Поделитесь своим местоположением и узнайте 3 ближайших к вам музея в Екатеринбурге.
+- **Поиск по интересам**: Выберите из различных категорий, таких как История, Архитектура, Искусство, Литература, Музыка, Наука и техника, Природа и Этнография.
+- **Рандомный музей**: Возможность рандомно выбрать музей в городе.
+- **Избранное**: Добавляйте понравившееся музеи в избранное, чтобы быстрее находить их в боте. 
+
+## Установка
+
+1. **Клонируйте репозиторий**:
+    ```bash
+    git clone https://github.com/korjeek/MuseumBot.git
+    cd MuseumBot
+    ```
+
+2. **Установите необходимые пакеты**:
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+3. **Настройте токен ваши переменные окружения `.env`**:
+   - Создайте файл `.env`.
+   - Впишите туда свой токен для ТГ бота и необходимые для БД переменные (`port`, `password`, `user` и т.д.)
+
+
+## Использование
+
+**1 Способ**:
+
+Чтобы запустить бота, просто выполните скрипт:
+
+```bash
+python3 main.py
+```
+
+**2 Способ**:
+
+Запуск бота можно сделать через `Docker`. `DockerFile` и `docker-compose.yml` приложены. Необходимо просто запустить `Docker` и
+вписать в терминал команду:
+
+```bash
+docker compose up
+```
+
+## Требования
+
+- `Python` версии не ниже **3.12.0**
+- `SQLAlchemy` версии не ниже **2.0.32**
+- `geopy` версии не ниже **2.4.1**
+- `aiogram` версии не ниже **3.12.0**
+- `requests` версии не ниже **2.32.3**
+- `beautifulsoup4` версии не ниже **4.12.3**
+
+Сейчас можно протестировать работу телеграм бота по ссылке: https://t.me/museum_ekb_bot

app/__pycache__/handlers.cpython-312.pyc

@@ -0,0 +1,61 @@
+from dotenv import load_dotenv
+from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
+from sqlalchemy.ext.asyncio import AsyncAttrs, async_sessionmaker, create_async_engine
+from sqlalchemy import String, BigInteger, ForeignKey, Column, URL
+import os
+
+load_dotenv()
+postgres_url = URL.create(
+    "postgresql+asyncpg",
+    username=os.getenv('POSTGRES_USER'),
+    password=os.getenv('POSTGRES_PASSWORD'),
+    host=os.getenv('POSTGRES_HOST'),
+    database=os.getenv('POSTGRES_DB'),
+    port=os.getenv('POSTGRES_PORT')
+)
+
+engine = create_async_engine(url=postgres_url)
+async_session = async_sessionmaker(engine)
+
+
+class Base(AsyncAttrs, DeclarativeBase):
+    pass
+
+
+class User(Base):
+    __tablename__ = 'users'
+
+    id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    user_id = Column(BigInteger, unique=True)
+
+
+class Museum(Base):
+    __tablename__ = 'museums'
+
+    id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    name: Mapped[str] = mapped_column(String(80))
+    category: Mapped[int] = mapped_column(ForeignKey('categories.id'))
+    latitude: Mapped[str] = mapped_column(String(10))
+    longitude: Mapped[str] = mapped_column(String(10))
+    site: Mapped[str] = mapped_column(String(110))
+    request_site: Mapped[str] = mapped_column(String(120))
+
+
+class Category(Base):
+    __tablename__ = 'categories'
+
+    id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    name: Mapped[str] = mapped_column(String(20))
+
+
+class Favorite(Base):
+    __tablename__ = 'favorite'
+
+    id: Mapped[int] = mapped_column(primary_key=True)
+    user: Mapped[int] = mapped_column(ForeignKey('users.id'))
+    museum: Mapped[int] = mapped_column(ForeignKey('museums.id'))
+
+
+async def create_tables():
+    async with engine.begin() as conn:
+        await conn.run_sync(Base.metadata.create_all)

app/__pycache__/paginator.cpython-312.pyc

@@ -0,0 +1,80 @@
+from app.database.models import async_session, Category, Museum, Favorite, User
+from sqlalchemy import select
+from geopy.distance import geodesic
+
+
+# =======================================Пользователи======================================
+async def set_user(user_id):
+    async with async_session() as session:
+        user = await session.scalar(select(User).where(User.user_id == user_id))
+
+        if not user:
+            session.add(User(user_id=user_id))
+            await session.commit()
+
+
+async def get_user_id(user_id):
+    async with async_session() as session:
+        return await session.scalar(select(User.id).where(User.user_id == user_id))
+
+
+# ========================================Категории========================================
+async def get_categories():
+    async with async_session() as session:
+        return await session.scalars(select(Category))
+
+
+async def get_category_name(category_id: int):
+    async with async_session() as session:
+        category_name = await session.scalar(select(Category).where(Category.id == category_id))
+        return category_name.name
+
+
+# ==========================================Музеи==========================================
+async def get_museums(category_id: int):
+    async with async_session() as session:
+        return await session.scalars(select(Museum).where(Museum.category == category_id))
+
+
+async def get_museum(museum_id):
+    async with async_session() as session:
+        return await session.scalar(select(Museum).where(Museum.id == museum_id))
+
+
+async def get_local_museums(user_location: tuple[float, float]):
+    async with async_session() as session:
+        museums = list(await session.scalars(select(Museum)))
+        museums.sort(key=lambda museum: get_distance(user_location, (museum.latitude, museum.longitude)))
+        return museums[:3]
+
+
+def get_distance(user_location: tuple[float, float], museum_location: tuple[float, float]) -> float:
+    return geodesic(museum_location, user_location).meters
+
+
+# ========================================Избранное========================================
+async def check_favorite(user_id: int, museum: int):
+    async with async_session() as session:
+        user = await get_user_id(user_id)
+        favorite = await session.scalar(select(Favorite).where(Favorite.museum == museum and Favorite.user == user))
+        return True if favorite else False
+
+
+async def change_favorite(user_id: int, museum: int):
+    async with async_session() as session:
+        user = await get_user_id(user_id)
+        favorite = await session.scalar(select(Favorite).where(Favorite.museum == museum and Favorite.user == user))
+
+        if not favorite:
+            session.add(Favorite(user=user, museum=museum))
+        else:
+            await session.delete(favorite)
+        await session.commit()
+
+
+async def get_favorite_museums(user_id: int):
+    async with async_session() as session:
+        user = await get_user_id(user_id)
+        favorite_museums = await session.scalars(select(Favorite.museum).where(Favorite.user == user))
+
+        return [await get_museum(museum_id) for museum_id in favorite_museums]

app/database/__pycache__/models.cpython-312.pyc

@@ -0,0 +1,108 @@
+from aiogram import Router, F
+from aiogram.filters import CommandStart, Command
+from aiogram.types import Message, CallbackQuery, ContentType, ReplyKeyboardRemove
+from app.messages.keyboards import Keyboard, CategoryCallback, RandomCallback, LocalCallback, FavoriteCallback
+from app.messages import text
+from app.database.requests import change_favorite, set_user
+from app.messages.creator import Creator
+from random import randint
+
+router = Router()
+kbd = Keyboard()
+creator = Creator()
+
+
+# ========================================Команды==========================================
+@router.message(CommandStart())
+async def start(message: Message):
+    await set_user(message.from_user.id)
+    await message.answer(text=text.START_MESSAGE)
+
+
+@router.message(Command('choose'))
+async def choose(message: Message):
+    await message.answer(text=text.CHOOSE_MESSAGE, reply_markup=await kbd.categories())
+
+
+@router.message(Command('random'))
+async def random(message: Message):
+    keyboard, museum_data = await creator.random_museum_msg(message.from_user.id, randint(1, 37))
+    await message.answer(text=museum_data, reply_markup=keyboard, parse_mode='html')
+
+
+@router.message(Command('locate'))
+async def locate(message: Message):
+    await message.answer(text=text.LOCATION_REQ_MESSAGE, reply_markup=await kbd.location_kbd())
+
+
+@router.message(Command('favorites'))
+async def favorites(message: Message):
+    keyboard, museum_data = await creator.favorite_museum_msg(FavoriteCallback(page=1), message.from_user.id)
+
+    if keyboard is None:
+        await message.answer(text=text.FAVORITE_EMPTY_MESSAGE)
+    else:
+        await message.answer(text=museum_data, reply_markup=keyboard, parse_mode='html')
+
+
+# ==================================Callback-Обработчики===================================
+@router.callback_query(CategoryCallback.filter())
+async def category_callback_query(call: CallbackQuery, callback_data: CategoryCallback) -> None:
+    # Нужно ли изменить состояние музея на 'избранное / не избранное'
+    if callback_data.change_favorite_state:
+        await change_favorite(call.from_user.id, callback_data.museum)
+    # Нужно ли вернуться в начальное меню
+    if callback_data.close:
+        await call.message.edit_text(text=text.CHOOSE_MESSAGE, reply_markup=await kbd.categories())
+    # Иначе, создание новой страницы музея
+    else:
+        keyboard, museum_data = await creator.category_museum_msg(callback_data, call.from_user.id)
+        await call.message.edit_text(text=museum_data, reply_markup=keyboard, parse_mode='html')
+
+
+@router.callback_query(RandomCallback.filter())
+async def back_callback_query(call: CallbackQuery, callback_data: CategoryCallback) -> None:
+    # Нужно ли изменить состояние музея на 'избранное / не избранное'
+    if callback_data.change_favorite_state:
+        await change_favorite(call.from_user.id, callback_data.museum)
+
+    # Создание новой страницы музея
+    keyboard, museum_data = await creator.random_museum_msg(call.from_user.id, callback_data.museum)
+    await call.message.edit_text(text=museum_data, reply_markup=keyboard, parse_mode='html')
+
+
+@router.message(F.content_type == ContentType.LOCATION)
+async def locate_museums(message: Message):
+    # Удаление кнопки 'запроса'
+    await message.answer(text=text.LOCATE_MESSAGE, reply_markup=ReplyKeyboardRemove())
+
+    # Создание новой страницы музея
+    callback_data = LocalCallback(latitude=message.location.latitude, longitude=message.location.longitude, page=1)
+    keyboard, museum_data = await creator.local_museum_msg(callback_data, message.from_user.id)
+    await message.answer(text=museum_data, reply_markup=keyboard, parse_mode='html')
+
+
+@router.callback_query(LocalCallback.filter())
+async def geo_callback_query(call: CallbackQuery, callback_data: LocalCallback):
+    # Нужно ли изменить состояние музея на 'избранное / не избранное'
+    if callback_data.change_favorite_state:
+        await change_favorite(call.from_user.id, callback_data.museum)
+
+    # Создание новой страницы музея
+    keyboard, museum_data = await creator.local_museum_msg(callback_data, call.from_user.id)
+    await call.message.edit_text(text=museum_data, reply_markup=keyboard, parse_mode='html')
+
+
+@router.callback_query(FavoriteCallback.filter())
+async def favorite_callback_query(call: CallbackQuery, callback_data: FavoriteCallback):
+    # Нужно ли изменить состояние музея на 'избранное / не избранное'
+    if callback_data.change_favorite_state:
+        await change_favorite(call.from_user.id, callback_data.museum)
+
+    # Создание новой страницы музея
+    keyboard, museum_data = await creator.favorite_museum_msg(callback_data, call.from_user.id)
+
+    if keyboard is None:
+        await call.message.edit_text(text=text.FAVORITE_EMPTY_MESSAGE)
+    else:
+        await call.message.edit_text(text=museum_data, reply_markup=keyboard, parse_mode='html')