bongram 0.1.1
Фреймворк для мгновенного создания Telegram-ботов на готовых шаблонах
Requires Python: >=3.8

# Bongram

**Bongram** — фреймворк для мгновенного создания Telegram-ботов на готовых шаблонах. Экономьте часы разработки: магазин, поддержка, рассылка или опрос — соберите бота из модулей за минуты. Поддержка платежей, админки, аналитики и кастомизации из коробки. Python-стиль, документация и примеры. Создавайте, а не кодируйте повторно!

## 🚀 Быстрый старт

### Установка

```bash
pip install bongram
```

### Запуск бота за 5 минут

```bash
bongram support YOUR_BOT_TOKEN
bongram faq YOUR_BOT_TOKEN
bongram giveaway YOUR_BOT_TOKEN
bongram polling YOUR_BOT_TOKEN
bongram newsletter YOUR_BOT_TOKEN
bongram booking YOUR_BOT_TOKEN
bongram quiz YOUR_BOT_TOKEN
bongram referral YOUR_BOT_TOKEN
bongram feedback YOUR_BOT_TOKEN
bongram reminder YOUR_BOT_TOKEN
bongram filemanager YOUR_BOT_TOKEN
bongram moderator YOUR_BOT_TOKEN
bongram paymentsplitter YOUR_BOT_TOKEN
```

Где `YOUR_BOT_TOKEN` — токен вашего бота от [@BotFather](https://t.me/BotFather).

## 📦 Доступные шаблоны

### Support (Поддержка)

Бот для обработки вопросов пользователей с админ-панелью.

**Возможности:**
- Пользователи могут задавать вопросы через кнопку
- Администраторы получают уведомления о новых вопросах
- Ответы администраторов автоматически отправляются пользователям
- Управление администраторами через команды

**Команды для пользователей:**
- `/start` — начать работу с ботом

**Команды для администраторов:**
- `/admin` — открыть админ-панель
- `/addadmin <user_id>` — добавить администратора

### FAQ (База знаний)

Бот с часто задаваемыми вопросами и поиском по базе знаний.

**Возможности:**
- Категории вопросов и ответов
- Поиск по базе знаний
- Админ-панель для управления вопросами
- Добавление, редактирование и удаление вопросов
- Статистика по категориям

**Команды для пользователей:**
- `/start` — открыть меню категорий
- `/search <запрос>` — поиск по базе знаний

**Команды для администраторов:**
- `/addadmin <user_id>` — добавить администратора
- Админ-панель доступна через меню

### Giveaway (Розыгрыши)

Бот для проведения розыгрышей и конкурсов.

**Возможности:**
- Создание розыгрышей с настраиваемым количеством победителей
- Регистрация участников
- Автоматическое определение победителей
- Таймер до окончания розыгрыша
- Статистика и управление розыгрышами

**Команды для пользователей:**
- `/start` — просмотр активных розыгрышей

**Команды для администраторов:**
- `/create` — создать новый розыгрыш
- `/addadmin <user_id>` — добавить администратора

### Polling (Опросы)

Бот для создания и проведения опросов с голосованием.

**Возможности:**
- Создание опросов с множественным выбором
- Анонимные и публичные опросы
- Статистика голосования в реальном времени
- Закрытие и управление опросами
- История созданных опросов

**Команды для пользователей:**
- `/start` — просмотр активных опросов

**Команды для администраторов:**
- `/create` — создать новый опрос
- `/addadmin <user_id>` — добавить администратора

### Newsletter (Рассылка)

Бот для массовых рассылок подписчикам.

**Возможности:**
- Управление подписчиками
- Отправка текстовых сообщений, фото и документов
- Планирование рассылок
- Статистика подписчиков
- Сегментация аудитории

**Команды для пользователей:**
- `/start` — подписаться/отписаться от рассылок

**Команды для администраторов:**
- `/send` — отправить рассылку
- `/addadmin <user_id>` — добавить администратора

### Booking (Бронирование)

Бот для бронирования времени и слотов.

**Возможности:**
- Календарь доступности
- Бронирование временных слотов
- Автоматические напоминания за час до бронирования
- Управление бронированиями
- История бронирований

**Команды для пользователей:**
- `/start` — открыть меню бронирования

**Команды для администраторов:**
- `/addadmin <user_id>` — добавить администратора

### Quiz (Викторины)

Бот для создания и прохождения викторин с вопросами.

**Возможности:**
- Создание викторин с вопросами и вариантами ответов
- Система подсчета очков
- Рейтинг игроков
- Разные уровни сложности
- История прохождения

**Команды для пользователей:**
- `/start` — выбрать викторину для прохождения

**Команды для администраторов:**
- `/create` — создать викторину
- `/addadmin <user_id>` — добавить администратора

### Referral (Реферальная программа)

Бот для реферальной программы с отслеживанием приглашений.

**Возможности:**
- Генерация персональных реферальных ссылок
- Отслеживание приглашенных пользователей
- Начисление бонусов за рефералов
- Статистика по рефералам
- Топ рефералов

**Команды для пользователей:**
- `/start` — получить реферальную ссылку

**Команды для администраторов:**
- `/addadmin <user_id>` — добавить администратора

### Feedback (Отзывы)

Бот для сбора отзывов и оценок от пользователей.

**Возможности:**
- Сбор текстовых отзывов
- Система оценок (1-5 звезд)
- Статистика отзывов
- Средняя оценка
- Распределение оценок

**Команды для пользователей:**
- `/start` — оставить отзыв или оценку

**Команды для администраторов:**
- `/addadmin <user_id>` — добавить администратора

### Reminder (Напоминания)

Бот для создания персональных напоминаний.

**Возможности:**
- Создание напоминаний с текстом
- Установка времени напоминания
- Список активных напоминаний
- Автоматическая отправка напоминаний
- Удаление напоминаний

**Команды для пользователей:**
- `/start` — управление напоминаниями

**Команды для администраторов:**
- `/addadmin <user_id>` — добавить администратора

### File Manager (Файловый менеджер)

Бот для хранения и управления файлами.

**Возможности:**
- Загрузка файлов (документы, фото, видео, аудио)
- Хранение файлов пользователя
- Доступ к сохраненным файлам
- Список всех файлов
- Управление файлами

**Команды для пользователей:**
- `/start` — открыть файловый менеджер

**Команды для администраторов:**
- `/addadmin <user_id>` — добавить администратора

### Moderator (Модератор групп)

Бот для модерации групп и каналов Telegram.

**Возможности:**
- Бан и разбан пользователей
- Заглушка пользователей на время
- Фильтр запрещенных слов
- Автоматическое удаление сообщений
- Статистика модерации

**Команды для администраторов:**
- `/ban <user_id>` — забанить пользователя
- `/unban <user_id>` — разбанить пользователя
- `/mute <user_id> <минуты>` — заглушить пользователя
- `/unmute <user_id>` — снять заглушку
- `/addword <слово>` — добавить запрещенное слово
- `/delword <слово>` — удалить запрещенное слово
- `/stats` — статистика модерации
- `/addadmin <user_id>` — добавить администратора

### Payment Splitter (Разделитель счетов)

Бот для разделения счетов между участниками.

**Возможности:**
- Создание счетов с указанием суммы
- Добавление участников
- Автоматический расчет суммы с каждого
- Отслеживание оплаты
- Уведомления участникам

**Команды для пользователей:**
- `/start` — управление счетами
- `/pay <bill_id>` — отметить оплату

**Команды для администраторов:**
- `/addadmin <user_id>` — добавить администратора

**Настройка администраторов:**
После первого запуска используйте команду `/addadmin <ваш_user_id>` в боте, чтобы добавить себя в администраторы. Ваш user_id можно узнать у бота [@userinfobot](https://t.me/userinfobot).

## 📝 Примеры использования

### Запуск бота поддержки

```bash
bongram support 1234567890:ABCdefGHIjklMNOpqrsTUVwxyz
```

### Запуск FAQ бота

```bash
bongram faq 1234567890:ABCdefGHIjklMNOpqrsTUVwxyz
```

### Запуск бота розыгрышей

```bash
bongram giveaway 1234567890:ABCdefGHIjklMNOpqrsTUVwxyz
```

### Запуск других шаблонов

```bash
bongram polling 1234567890:ABCdefGHIjklMNOpqrsTUVwxyz
bongram newsletter 1234567890:ABCdefGHIjklMNOpqrsTUVwxyz
bongram booking 1234567890:ABCdefGHIjklMNOpqrsTUVwxyz
bongram quiz 1234567890:ABCdefGHIjklMNOpqrsTUVwxyz
bongram referral 1234567890:ABCdefGHIjklMNOpqrsTUVwxyz
bongram feedback 1234567890:ABCdefGHIjklMNOpqrsTUVwxyz
bongram reminder 1234567890:ABCdefGHIjklMNOpqrsTUVwxyz
bongram filemanager 1234567890:ABCdefGHIjklMNOpqrsTUVwxyz
bongram moderator 1234567890:ABCdefGHIjklMNOpqrsTUVwxyz
bongram paymentsplitter 1234567890:ABCdefGHIjklMNOpqrsTUVwxyz
```

## 🛠 Разработка

### Установка для разработки

```bash
git clone https://github.com/THWEDOKA/bongram.git
cd bongram
pip install -e .
```

## 👨‍💻 Автор

**Triazov Kirill**

- 🌐 Сайт: [triazov.ru](https://triazov.ru)
- 💻 GitHub: [@THWEDOKA](https://github.com/THWEDOKA)

## 📄 Лицензия

MIT License

## 🤝 Вклад в проект

Мы приветствуем вклад в развитие Bongram! Создавайте issues и pull requests.

## 📞 Поддержка

Если у вас возникли вопросы или проблемы:
- Создайте [issue в репозитории](https://github.com/THWEDOKA/bongram/issues)
- Напишите на [triazov.ru](https://triazov.ru)