Skip to content

Latest commit

 

History

History
90 lines (56 loc) · 1.96 KB

README.rst

File metadata and controls

90 lines (56 loc) · 1.96 KB

Simple Twitch auth

Wanna enable your awesome Django application to register and authenticate user using Twitch profiles?
This application was created especially for your needs

Features

  • Easy to use
  • Ready to Twitch channel name changes
  • Username cases are synchronized to Twitch display_name
  • User emails are synchronized to Twitch

Installation

Ensure that Django ‘sites’ framework is enabled.

Python package Downloads

pip install django-simpletwitchauth

settings.py:

Add twitch_auth to INSTALLED_APPS

Add twitch_auth.backends.OAuth2Backend to AUTHENTICATION_BACKENDS

Set Twitch application settings

Example using django-environ:

env = environ.Env()

TWITCH_AUTH_CLIENT_ID = env('TWITCH_CLIENT_ID', default='some_client_id')
TWITCH_AUTH_CLIENT_SECRET = env('TWITCH_CLIENT_SECRET', default='some_client_secret')

All available settings:

TWITCH_AUTH_SCOPE

Defines OAuth2 token scope

Defaults to user_read

TWITCH_AUTH_PROTOCOL

Defines protocol that is used to build full authentication callback URI

Defaults to http://

TWITCH_AUTH_CLIENT_ID

Defines Twitch application client ID

TWITCH_AUTH_CLIENT_SECRET

Defines Twitch application client secret

TWITCH_AUTH_REDIRECT_URI

Defines default redirect URI after successful authentication

Defaults to /

Usage

  • Run migrations to create database tables for entities.
  • Add somewhere in your templates link to url login_twitch