django-tgauth 0.1.4

App for Django and DRF which give an opportunity to login via TG.

Django Telegram Authentication

Simple Django app for authentication via Telegram.

Installation

pip install django-tgauth

Quick start

1. Add "auth_tg" to your INSTALLED_APPS setting:

INSTALLED_APPS = [
    ...
    'auth_tg',
]

2. Add your Telegram Bot settings to settings.py:

BOT_TOKEN = 'your-bot-token'
BOT_USERNAME = 'your-bot-username'

3. You can add an additional checking on your telegram channels. Just add these without gap:

CHANNELS = '12345678910,12345678911'
CHANNEL_NAMES = '@channel1,@channel2'

4. Add backend and custom user model into settings.py as well:

AUTH_USER_MODEL = 'auth_tg.User'

AUTHENTICATION_BACKENDS = [
    'auth_tg.authentication.TelegramAuthBackend',
    'django.contrib.auth.backends.ModelBackend',
]

5. Include the auth_tg URLconf to your project urls.py:

path('auth/', include('auth_tg.urls')),

6. You can try out this functional: Add new app:

   cd yourproject-name
   

   python manage.py startapp yourapp_name
   

   Then you need to create urls.py and add this code:

   from django.urls import path
   from .views import *
   
   urlpatterns = [
       path('', Home.as_view(), name='home'),
       path('profile/', Profile.as_view(), name='profile')
   ]
   

   And add simple views to views.py:

   from auth_tg.views import TgAuthProfileView, TgAuthHomeView
   
   class Home(TgAuthHomeView):
       ...
   
   class Profile(TgAuthProfileView):
       ...
   

   Don't forget to add your new app to INSTALLED_APPS and URLconf:

   INSTALLED_APPS = [
       ...
       'auth_tg',
       'yourapp_name',
   ]
   

   path('', include('yourapp_name.urls')),
   

7. Run migrations:

python manage.py makemigrations

python manage.py migrate

8. If you want to use your own base.html then you need to add this to your html file.

<script src="{% static 'auth_tg/js/telegramAuth.js' %}"></script>