tvules / saverbot

SaverBot — Tg-bot помогает добавить новые ресурсы для crawler. https://t.me/SsssaverBot

SaverBot

Содержание

1. Описание
   • Возможности
   • Технологии
2. Установка и запуск
   • Зависимости
   • Установка
   • Запуск (Docker)
   • Запуск (Локально)
3. Использование
4. Дополнительная информация
   • Переменные окружения
5. Авторы

Note: Тестовое задания (описание).

Telegram-бот, который помогает быстро и удобно добавлять новые ресурсы для парсинга. Таким образом, бот облегчает работу с crawler без UI.

Возможности

• Быстрое и удобное добавление новых ресурсов для парсинга.

Технологии

Установка и Запуск

Набор инструкций, необходимых для запуска приложения.

Зависимости

• Python 3.10+
• Docker Compose – *необязательно

Установка

1. Клонировать репозиторий.

   git clone https://github.com/tvules/SaverBot.git
   cd SaverBot

2. Переименовать файл .env.example в .env и задать переменные окружения.

   BOT_TOKEN=<Токен аутентификации бота>

Запуск (Docker)

1. Выполнить сборку и запуск контейнера Docker.

   docker compose up -d

   Note: В старый версиях Docker используется команда docker-compose.

Запуск (Локальный)

1. Установить зависимости.

   pip install -r requirements.txt

2. Применить миграции базы данных.

   alembic upgrade head

3. Выполнить запуск модуля.

   python -m tgbot

Использование

Пользователь может прислать боту Exсel файл с полями:

• title – Описание
• url – URL-адрес ресурса
• xpath – X-Path селектор для поиска цены

После загрузки файла бот сохранит его содержимое в базу данных.

Дополнительная Информация

Информация полезная для использования и разработки.

Переменные окружения

• BOT_TOKEN – Токен аутентификации tg-бота, выданный BotFather.
• DB_URL – URL-адрес для подключения к базе данных. По умолчанию: sqlite+aiosqlite:///db.sqlite3.
• DOWNLOADS_DIR – Путь до дирректории куда сохранять полученный Excel файл.

Авторы

• Илья Петрухин (Разработчик) — GitHub

saverbot's Issues

Fix typos in the project description

• 115: Чрезмерное использование слова "файл".
• 123: Заменить слова "авторизации" на "аутентификации"