Authentication provider for graphene-django and Google Firebase's Authentication service.
Project description
# graphene-django-firebase-auth
Authentication provider for graphene-django and Firebase’s Authentication service.
Note this is a WIP and abandoned project since I never ended up using Firebase. But the code is still a good starting point as of writing this.
Partially inspired by [django-firebase-auth](https://github.com/fcornelius/django-firebase-auth) for Django REST framework.
This app is used with [Firebase Authentication](https://firebase.google.com/docs/auth/) on a client.
## Compatibility
This code has only been tested with Python 3.7.0 and Django 2.1.2.
## Installing
Install the app:
`sh pipenv install graphene-django-firebase-auth `
Download the JSON file from your [Firebase console](https://console.firebase.google.com/) with your account’s credentials.
Set FIREBASE_KEY_FILE in your project’s settings to the path of the credentials file:
`python import os FIREBASE_KEY_FILE = os.path.join(BASE_DIR, 'path/to/firebase-credentials.json') `
Add the authentication backend to AUTHENTICATION_BACKENDS:
`python AUTHENTICATION_BACKENDS = ['firebase_auth.authentication.FirebaseAuthentication'] `
Add firebase_auth to INSTALLED_APPS:
`python INSTALLED_APPS = [ 'firebase_auth', ] `
Add FirebaseAuthMixin to your AUTH_USER_MODEL:
`python class User(PermissionsMixin, FirebaseAuthMixin): `
Build and run your DB migrations to add the changes:
`sh ./manage.py makemigrations ./manage.py migrate `
## Sending tokens on the client
Your client will need to send an Authorization: Bearer token on each request. How you do this depends on your client and is outside the scope of this documentation.
## Developing
### Setting up your environment
Install the dependencies:
`sh pipenv install -d `
Download the JSON file from your [Firebase console](https://console.firebase.google.com/) with your account’s credentials.
Create an .env file using .env.example as a template. Make sure to specify the path to the file in the previous step.
Enter the virtual environment:
`sh ./manage.py shell `
### Other commands
`sh # Run the tests ./manage.py test `
`sh # Lint the code ./lint.sh `
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_graphene_firebase_auth-0.0.22.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e6e988df9aafff3357e3b78ce0917a6b82702591389753f01356919bfa44863 |
|
MD5 | 1432ad39310342198ba5bcdd6586b717 |
|
BLAKE2b-256 | 0ebc46cae1cbda163b79fcef55e2ad896685b6e2c8f2bc186513d602186dc860 |
Hashes for django_graphene_firebase_auth-0.0.22-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 743d25a6243def5607400f841039b1dc937a1ff795c41440bb8ea34cb3772965 |
|
MD5 | b85b9648633148b53c7267dfdecefd78 |
|
BLAKE2b-256 | da5617d9d16ebab70bf62e592ac37bf31ec4bd258cda83b56a5b94995285e7e5 |