Skip to main content

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

  1. Install the app:

`sh pipenv install graphene-django-firebase-auth `

  1. Download the JSON file from your [Firebase console](https://console.firebase.google.com/) with your account’s credentials.

  2. 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') `

  1. Add the authentication backend to AUTHENTICATION_BACKENDS:

`python AUTHENTICATION_BACKENDS = ['firebase_auth.authentication.FirebaseAuthentication'] `

  1. Add firebase_auth to INSTALLED_APPS:

`python INSTALLED_APPS = [ 'firebase_auth', ] `

  1. Add FirebaseAuthMixin to your AUTH_USER_MODEL:

`python class User(PermissionsMixin, FirebaseAuthMixin): `

  1. 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

  1. Install the dependencies:

`sh pipenv install -d `

  1. Download the JSON file from your [Firebase console](https://console.firebase.google.com/) with your account’s credentials.

  2. Create an .env file using .env.example as a template. Make sure to specify the path to the file in the previous step.

  3. 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

graphene_django_firebase_auth-0.0.21.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file graphene_django_firebase_auth-0.0.21.tar.gz.

File metadata

File hashes

Hashes for graphene_django_firebase_auth-0.0.21.tar.gz
Algorithm Hash digest
SHA256 c26be1e6a6b2804932563e4e18f9110805fe6daed4af6770b3a3f7fbc8415194
MD5 7109b1fa1676cd5eeb138399c5b0cba5
BLAKE2b-256 682704515a44644e20300f83415bca710e4ee46a153462f3aa8ebfbc985835d8

See more details on using hashes here.

File details

Details for the file graphene_django_firebase_auth-0.0.21-py3-none-any.whl.

File metadata

File hashes

Hashes for graphene_django_firebase_auth-0.0.21-py3-none-any.whl
Algorithm Hash digest
SHA256 f4affae45bdba4c6b11117cbca8a5bc96a664776d59eb27b25a4b349250a65ca
MD5 8143698cfee5398871a875b866649dd4
BLAKE2b-256 3b45e1e677aac959aaab78efc9efdd0fe22e0096d0f7028bf071290fb44869fc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page