A flexible Django Rest Framework Firebase authentication class
Project description
Django Rest Framework Firebase Authentication
This package provides a base Firebase Authentication backend class for the Django rest framework. Two key methods are not implemented for more flexebility. Let's keep it simple, stupid.
Requirements
- Python 2.7 or 3.4+
- Django (version 1.11+)
- Django Rest Framework
- Firebase Admin Python
Installation
pip install drf-firebase-authentication
Usage
1. Subclass BaseFirebaseAuthentication
and implement its template methods:
Decide by yourself how you want to associate Firebase users with local django users by implementing the .get_django_user()
method accordingly.
Put your code into a authentication.py
file inside an app dedicated to your projects REST Api.
from drf_firebase.authentication import BaseFirebaseAuthentication
from firebase_admin import credentials, initialize_app
from django.contrib.auth import get_user_model
firebase_creds = credentials.Certificate('path/to/firebase/credentials.json')
firebase_app = initialize_app(firebase_creds)
class FirebaseAuthentication(BaseFirebaseAuthentication):
"""
Example implementation of a DRF Firebase Authentication backend class
"""
def get_firebase_app(self):
return firebase_app
def get_django_user(self, firebase_user_record):
return get_user_model().objects.get_or_create(
username=firebase_user_record.uid,
)[0]
2. Add the just created Firebase authentication backend to your settings.py
:
Replace YOUR_RESTAPI_APP
with the app you put your authentication.py
file in.
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': (
'rest_framework.authentication.SessionAuthentication', # default
'rest_framework.authentication.BasicAuthentication', # default
'YOUR_RESTAPI_APP.authentication.FirebaseAuthentication',
),
}
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for drf-firebase-authentication-0.1.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 792a526d77a2417c123e10f2864064712cd56cd9af63bd651edca7c7e90f6d5c |
|
MD5 | be778149264df5058521f189ba7b0a5a |
|
BLAKE2b-256 | ea00006cde8bf0473224f626eb7e85deda2cab7b9acc12c3b4f8c54235fc21af |