django-telegram-app 0.1.1

A Django app that integrates with Telegram to create bots.

django-telegram-app

A Django app to integrate Telegram bots into your project.

Detailed documentation is in the docs/ directory.

---

---

Features

• ✅ Command-based bot architecture with step-based flow
• ✅ Swappable TelegramSettings model
• ✅ Inline admin integration for linking Telegram settings to users
• ✅ Extensible: add commands per app via auto-discovery
• ✅ Built-in system checks for misconfiguration
• ✅ Django ORM integration (no direct API handling required)
• ✅ Easy to test (includes custom TelegramTestCase)

Requirements (officially supported)

• Python 3.10+
• Django 5.2+

Quick start

1. Install the package

   pip install django-telegram-app
   

2. Add "django_telegram_app" to your INSTALLED_APPS setting like this:

   INSTALLED_APPS = [
       ...,
       "django_telegram_app",
   ]
   

3. Include the telegram URLconf in your project urls.py like this:

   ...
   from django_telegram_app.conf import settings as telegram_app_settings
   ...
   path(telegram_app_settings.ROOT_URL, include("django_telegram_app.urls")),
   

4. Create your own commands in each app under {appname}/telegrambot/commands/. Refer to the documentation for more details on how to write custom commands.

5. Add the provided telegramsettings inline to your user-model like this:

   # user/admin.py
   from django_telegram_app.admin import TelegramSettingInline
   ...
   class CustomUserAdmin(UserAdmin):
       ...
       inlines = [TelegramSettingInline]
       # or add it to an existing entry
   

6. Configure the telegram settings. Refer to the documentation for all possible settings. Minimal configuration is like this:

   # project/settings.py
   ...
   TELEGRAM = {
       "BOT_URL": "https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11/"
   }
   ...
   

7. Run python manage.py migrate to create the models.

8. Run python manage.py setwebhook to set the url on which you would like to receive telegram updates.

9. Start the development server and visit the admin to edit users and add/complete TelegramSettings there.

License

This project is licensed under the MIT License — see the LICENSE file for details.