An open API service indexing awesome lists of open source software.

https://github.com/pyadrus/instinktbot

InstinktBot — это телеграм-бот для сети салонов «Инстинкт», позволяющий пользователям получать бонусы и участвовать в ежедневных розыгрышах. Бот автоматически отправляет приветственные сообщения, обрабатывает данные пользователей и предоставляет возможность экспорта информации администраторам.
https://github.com/pyadrus/instinktbot

aiogram aiogram2 aiogram3 loguru sqlite sqlite3

Last synced: 9 months ago
JSON representation

InstinktBot — это телеграм-бот для сети салонов «Инстинкт», позволяющий пользователям получать бонусы и участвовать в ежедневных розыгрышах. Бот автоматически отправляет приветственные сообщения, обрабатывает данные пользователей и предоставляет возможность экспорта информации администраторам.

Awesome Lists containing this project

README

          

# InstinktBot

## 📋 Описание проекта

InstinktBot — это телеграм-бот для сети салонов «Инстинкт», позволяющий пользователям получать бонусы и участвовать в ежедневных розыгрышах. Бот автоматически отправляет приветственные сообщения, обрабатывает данные пользователей и предоставляет возможность экспорта информации администраторам.
### Основной функционал:
- **Регистрация пользователей:** бот записывает данные о пользователях, которые запускают его.
- **Получение бонусов:** пользователи могут получать случайные бонусы и призы.
- **Экспорт данных:** администраторы могут выгружать данные о пользователях и бонусах в формате Excel.
---

## 📦 Установка и запуск
1. Клонируйте репозиторий:
```bash
git clone https://github.com/username/InstinktBot.git
```
2. Установите зависимости:
```bash
pip install -r requirements.txt
```
3. Настройте базу данных в директории `database/`.
4. Запустите бота:
```bash
python main.py
```

---

## ⚙️ Функциональные модули

### Основные обработчики

- **`dobrolyudova_button_handler`** — обработка нажатий кнопки для Добролюбова.
- **`share_number`** — проверка наличия бонусов и ввод имени пользователя.
- **`write_phone`** — сохранение номера телефона пользователя и выдача бонуса.
- **`export_command`** — экспорт данных о бонусах в Excel для администраторов.
- **`register_dobrolyudova_handler()` и `register_admin_handler()`** — регистрация всех обработчиков.
---

## 📑 База данных

В проекте используется **SQLite** для хранения данных о пользователях и бонусах. Таблицы:
- **users_bonus** — хранит данные о выданных бонусах.
- **users** — хранит данные о пользователях, которые запускали бота.
---
## 🔒 Административные команды

- **`/export_bonus`** — выгрузка информации о бонусах.
- **`/export_user`** — выгрузка информации о пользователях.
### Доступ к командам ограничен пользователями с указанными ID.

---
## 💡 Как получить бонус?

1. Нажмите на кнопку «Добролюбова».
2. Введите ваше имя.
3. Получите случайный бонус, который можно предъявить администратору салона для получения приза.

---