Samara Modern Bot

Telegram-бот-экскурсовод по самарскому модерну: показывает маршрут прогулки, отправляет фотографии объектов и короткие исторические справки.

Проект оформлен как портфолио-кейс: исходный архив распакован, полезные материалы перенесены в репозиторий, черновые скрипты собраны в понятный Python-пакет, а секреты вынесены в переменные окружения.

О проекте

Бот помогает пользователю быстро начать прогулку по объектам самарского модерна:

• открывает маршрут в Яндекс.Картах;
• показывает карточки объектов с фотографиями;
• отправляет краткие описания зданий;
• поддерживает команды /start, /info, /route и /help;
• работает на long polling через Telegram Bot API.

Технологии

• Python 3.11+
• pyTelegramBotAPI
• python-dotenv
• unittest

Быстрый старт

python -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install -e .
Copy-Item .env.example .env

Заполните .env токеном от BotFather:

BOT_TOKEN=replace_with_your_telegram_bot_token
LOG_LEVEL=INFO

Запуск:

samara-modern-bot

Альтернативный запуск:

python -m samara_modern_bot

Команды бота

Команда	Назначение
/start	приветствие и основное меню
/info	список объектов маршрута
/route	ссылка на маршрут
/help	подсказка по старту

Структура репозитория

assets/                  фотографии объектов маршрута
src/samara_modern_bot/   исходный код Telegram-бота
tests/                   проверки данных маршрута
.env.example             пример локальной конфигурации
pyproject.toml           зависимости и entry point

Проверка

python -m unittest discover -s tests

Безопасность

Telegram-токен не хранится в актуальном коде и должен передаваться через .env или переменные окружения. Если токен когда-либо был опубликован в истории репозитория, его нужно перевыпустить через BotFather.

Roadmap

• расширить маршрут новыми объектами самарского модерна;
• добавить несколько тематических прогулок;
• вынести контент маршрутов в JSON или базу данных;
• добавить геометки, длительность прогулки и остановки маршрута;
• подготовить деплой на сервере или в Docker.