Библиотека (Framework) для быстрого создания Telegram ботов и интеграции с django
Тут можно найти Полную документацию проекта
- Идея проекта
- Проект с открытым исходным кодом
- Отличие от других Telegram проектов
- Функции библиотеки
- Зависимости
- Статус разработки
- Установка
- Быстрый старт
- Внести свой вклад в проект
Создать удобный и надежный framework для быстрого и удобного создания telegram ботов который:
- Имеет чёткую структуру модулей
- Может использовать разные библиотеки для взаимодействия с telegram (pyTelegramBotAPI, Telethone, python-telegram-bot, aiogram и другие)
- Позволяет быстро реализовать start-up проект одному разработчику или в небольшой команде
- Имеет интеграцию с django для соднаия web страниц и использования django admin
- Быстро подключается к базе данных с помощью Django ORM
Это проект с открытым исходным кодом с лицензией Happy Code.
- Свободное использование
- создание Forks
- публикация issues и bugs
- contributions
очень приветствуются
В отличие от библиотек для создания telegram ботов, таких как pyTelegramBotAPI, aiogram, python-telegram-bot и других, этот проект (Framework) имеет чёткую структуру, похожую на структуру django проектов. Framework содержит следующие элементы:
- models - модели данных связанные с базой данных с помощью Django ORM
- handlers - обработчики событий telegram bot-а (аналогия с django views)
- bot - связь команд и событий бота с обработчиками (аналогия с django urls)
- settings - настройки для всего проекта - django settings
- tests - тесты логики бота с использованием специального Dummy Bot
Под капотом Framework может использовать разные библиотеки в синхронном и асинхронном исполнении. Можно переключать одни библиотеки на другие. Без соединения с telegram (например в DEV) режиме, можно использовать Dummy Bot для разработки и тестирования.
Интеграция с django позволяет:
- Добавить web site
- Использовать django админку
- Использовать django ORM
- Интеграция telegram бота в django проект (В разработке)
- Понятная структура и интерфейсы для разработки бота (В разработке)
- Функции автоматического тестирования бота (В разработке)
- Совместимость с синхронным pyTelegramBotAPI (В разработке)
- Совместимость с асинхронным pyTelegramBotAPI (В разработке)
- DummyBot для тестирования и работы без подключения к telegram (В разработке)
- Основные функции телеграм бота (В разработке)
- Все функции телеграм бота (На этапе планирования)
- Совместимость с aiogram, python-telegram-bot, Telethone (На этапе планирования)
- django > 5
- pyTelegramBotAPi
- Подробности в Полной документации
Разработка только началась
- Пакет уже доступен в PyPi
- Подробности в Полной документации
pip install django-telegram-framework
Подробности в Полной документации
Добавить пакет в INSTALLED_APPS django проекта
INSTALLED_APPS = [
...,
'telegram_framework',
]Запустить команду с информацией
python manage.py package_info
Больше примеров в Полной документации
Без проблем! Для быстрого старта можно ознакомиться с: