Telegram-бот для анализа сайта Hotels.com и поиска
подходящих пользователю отелей

Описание задачи:
ТЗ на промежуточную аттестацию
Описание работы команд
Описание внешнего вида и UI
Технические требования

Описание задачи
Одно молодое и перспективное турагентство Too Easy Travel хочет стать номером 1 в
сфере организации самых разных туров. В том числе это касается и подбора
различных отелей и хостелов для клиентов. Однако менеджеры агентства, конечно же,
понимают, что конкуренция в этой сфере очень серьёзная. Агентству необходимо
иметь инструмент под рукой, который позволяет им сформировать актуальное
предложение для клиента быстрее конкурентов.
С предложением реализации такого инструмента компания Too Easy Travel обратилась
к вам: она заказала у вас программу, которая по определённым критериям и запросам
могла бы анализировать текущие предложения по отелям и выдавать необходимый
для турагентства (и туристов) результат.
Для этого агентство взяло один из самых крупных сайтов по бронированию на данный
момент — Hotels.com. Заказчик хочет, чтобы программа работала именно с ним.
Причём у сайта есть открытый (бесплатный!) API, над которым уже поработали другие
программисты, а значит, эти готовые разработки можно использовать.
Также заказчик старается экономить ресурсы там, где это возможно, поэтому вас
попросили реализовать это в виде Telegram-бота, так как он «съедает» довольно мало
трафика, а также не требует каких-либо сторонних денежных вложений (в отличие от
поддержки сайта, например). А ещё это позволяет оптимизировать и облегчить работу
менеджеров агентства, что также положительно скажется на эффективности всей
компании.

ТЗ:
Проект должен быть разработан на языке Python и должен быть легкопереносимым.
Это значит, что запуск проекта должен осуществляться путём клонирования
репозитория и установки необходимых библиотек. Подразумевается, что Telegram у
заказчика уже установлен.
Для разработки проекта используется открытый API Hotels, который расположен на
сайте rapidapi.com. Чтобы получить возможность работать с этим API, необходимо:
1. Зарегистрироваться на сайте rapidapi.com.
2. Перейти в API Marketplace → категория Travel → Hotels (либо просто перейти по
прямой ссылке на документацию Hotels API Documentation).
3. Нажать кнопку Subscribe to Test.
4. Выбрать бесплатный пакет (Basic).
Обращаем ваше внимание на то, что у базового пакета есть ограничение по
количеству запросов в месяц, а именно — 500. Поэтому если возникнет проблема с
нехваткой запросов для тестирования проекта, то просто зарегистрируйте ещё один
аккаунт (или даже несколько).
Проект состоит из скрипта main.py и Telegram-бота с вашим собственным названием.
Пользователь с помощью специальных команд бота может выполнить следующие
действия (получить следующую информацию):
1. Узнать топ самых дешёвых отелей в городе (команда /lowprice).
2. Узнать топ самых дорогих отелей в городе (команда /highprice).
3. Узнать топ отелей, наиболее подходящих по цене и расположению от центра
(самые дешёвые и находятся ближе всего к центру) (команда /bestdeal).
4. Узнать историю поиска отелей (команда /history)
Без запущенного скрипта бот на команды (и на что-либо ещё) не реагирует.
Описание работы команд
Команда /lowprice
После ввода команды у пользователя запрашивается:
1. Город, где будет проводиться поиск.
2. Количество отелей, которые необходимо вывести в результате (не больше
заранее определённого максимума).
3. Необходимость загрузки и вывода фотографий для каждого отеля (“Да/Нет”)
3.1. При положительном ответе пользователь также вводит количество
необходимых фотографий (не больше заранее определённого
максимума)

Команда /highprice
После ввода команды у пользователя запрашивается:
1. Город, где будет проводиться поиск.
2. Количество отелей, которые необходимо вывести в результате (не больше
заранее определённого максимума).
3. Необходимость загрузки и вывода фотографий для каждого отеля (“Да/Нет”)
3.1. При положительном ответе пользователь также вводит количество
необходимых фотографий (не больше заранее определённого
максимума)
Команда /bestdeal
После ввода команды у пользователя запрашивается:
1. Город, где будет проводиться поиск.
2. Диапазон цен.
3. Диапазон расстояния, на котором находится отель от центра.
4. Количество отелей, которые необходимо вывести в результате (не больше
заранее определённого максимума).
Необходимость загрузки и вывода фотографий для каждого отеля (“Да/Нет”)
4.1. При положительном ответе пользователь также вводит количество
необходимых фотографий (не больше заранее определённого
максимума)
Команда /history
После ввода команды пользователю выводится история поиска отелей. Сама история
содержит:
1. Команду, которую вводил пользователь.
2. Дату и время ввода команды.
3. Отели, которые были найдены.

Описание внешнего вида и UI
Окно Telegram-бота, который при запущенном Python-скрипте должен уметь
воспринимать следующие команды:
● /help — помощь по командам бота,
● /lowprice — вывод самых дешёвых отелей в городе,
● /highprice — вывод самых дорогих отелей в городе,
● /bestdeal — вывод отелей, наиболее подходящих по цене и расположению от
центра.
● /history — вывод истории поиска отелей
Для команд lowprice, highprice и bestdeal сообщение с результатом команды должно
содержать краткую информацию по каждому отелю. В эту информацию как минимум
входит:
● название отеля,
● адрес,
● как далеко расположен от центра,
● цена,
● N фотографий отеля (если пользователь счёл необходимым их вывод)

Технические требования:
● Скрипт для Telegram-бота должен быть написан с использованием библиотек
Pytelegrambotapi и requests.
● Запуск бота должен выполняться командой python main.py из Терминала, из
папки с проектом. Реализация main.py и остальных файлов проекта остаётся за
вами. Файлы не должны содержать ошибок, работа должна быть корректной.
● Техническая реализация. Команды бота, описанные в ТЗ, должны работать в
соответствии с постановкой. Также выдача результата производится
исключительно по соответствующей команде Telegram-бота.
● Интерфейс должен быть отзывчивым: при возникновении пользовательских
ошибок (ввод несуществующих команд, ввод данных неверного типа и так
далее) выводится соответствующее уведомление.
● К скрипту должен быть приложен файл readme.md, который содержит в себе
инструкцию (документацию) для работы со скриптом и пользователем.
● Нельзя использовать глобальные переменные.
● Должен быть реализован многопользовательский режим.
● Бот должен:
➢ запрашивать у пользователя информацию о том, с какого по какое число
считать стоимость гостиницы;
➢ выводить не только стоимость за ночь, но и суммарную стоимость.
● В выводе каждого отеля должна быть ссылка на страницу с отелем.
Формат сдачи материалов и оценивание
Для проекта должен использоваться отдельный Git-репозиторий в gitlab.skillbox.ru.
Разработка проекта делится на следующие основные этапы:
1. Создание бота, который реагирует на команду /hello-world, а также на текст
«Привет» (здесь также необходимо сообщить преподавателю имя вашего бота
для тестирования).
2. Реализация команды /lowprice.
3. Реализация команды /highprice.
4. Реализация команды /bestdeal.
5. Реализация команды /history
6. Сдача проекта.
На каждом этапе создаётся свой Merge Request (MR) на ветку master, который сдаётся
преподавателю для проведения код-ревью. Преподаватель оставляет замечания в
этом MR, и только после его одобрения запрос сливается в ветку master. Советуем
сделать первый MR с общей структурой проекта, где каждая команда Telegram-бота
вынесена в отдельный файл, чтобы в дальнейшем можно было создавать несколько
параллельных MR под каждый функционал из ТЗ. Это позволит вам, не ожидая
одобрения преподавателя, приступать к выполнению следующей задачи.
Таким образом, на этапе «Сдача проекта» вы сообщаете преподавателю о завершении
проекта, в котором уже должен быть реализован весь необходимый функционал
программы в соответствии с техническими требованиями.
Готовый проект проверяется по следующим критериям:
● Соответствие техническому заданию. Элементы должны работать так, как они
описаны в документе.
● Скрипт запускается без ошибок, Telegram-бот работает корректно.
● Отсутствие ошибок в результате каждой реализованной команды.
● Usability приложения. Сюда относится отзывчивость интерфейса: при наличии
ошибок при вводе данных пользователь получает соответствующее
уведомление.
● Чистый pythonic-код: соблюдение правил PEP, прописанная документация для
классов и функций, наличие аннотаций типов.
● Наличие файла readme.md, в котором для пользователя описывается
инструкция по эксплуатации скрипта и бота.
Работа возвращается на доработку, если:
● отсутствует или не работает базовая функциональность, описанная в ТЗ и
технических требованиях;
● имеются грубые ошибки в организации или структуре проекта;
● преподаватель не может запустить проект локально.
Дополнительные материалы (подсказки)
«Простой Telegram-бот на Python за 30 минут» — статья о том, как написать простую
программу для работы Telegram-бота.
«Инструкция: Как создавать ботов в Telegram» — статья о создании ботов в Telegram, а
также о написании программ для них. Здесь же говорится о том, откуда взять токен.

Готовый проект проверяется по следующим критериям:
● Соответствие техническому заданию. Элементы должны работать так, как они
описаны в документе.
● Скрипт запускается без ошибок, Telegram-бот работает корректно.
● Отсутствие ошибок в результате каждой реализованной команды.
● Usability приложения. Сюда относится отзывчивость интерфейса: при наличии
ошибок при вводе данных пользователь получает соответствующее
уведомление.
● Чистый pythonic-код: соблюдение правил PEP, прописанная документация для
классов и функций, наличие аннотаций типов.
● Наличие файла readme.md, в котором для пользователя описывается
инструкция по эксплуатации скрипта и бота.