django-github-oauth

Django github OAuth


Keywords
django, github, python
License
Unlicense
Install
pip install django-github-oauth==2021.6.5

Documentation

Installation

$ pip install django-github-oauth

How it works

  1. create OAuth app
  2. edit settings GITHUB_OAUTH_CLIENT_ID and GITHUB_OAUTH_SECRET
  3. add login and callback urls

settings.py

GITHUB_OAUTH_CLIENT_ID = os.getenv('DJANGO_GITHUB_OAUTH_CLIENT_ID')
GITHUB_OAUTH_SECRET = os.getenv('DJANGO_GITHUB_OAUTH_SECRET')
GITHUB_OAUTH_CALLBACK_URL = os.getenv('DJANGO_GITHUB_OAUTH_CALLBACK_URL')
GITHUB_OAUTH_SCOPES = []

AUTH_USER_MODEL = 'users.User'
AUTHENTICATION_BACKENDS = ('django_github_oauth.backend.Backend',) # passwordless auth
LOGIN_REDIRECT_URL = '/'
LOGOUT_REDIRECT_URL = '/'

urls.py

urlpatterns+= [
    path('login', include('django_github_oauth.urls.login')),
    path('login-github-callback', include('django_github_oauth.urls.callback')),
    path('logout', include('django_github_oauth.urls.logout')),
]