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

django_graphene_firebase_auth-0.0.32.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file django_graphene_firebase_auth-0.0.32.tar.gz.

File metadata

File hashes

Hashes for django_graphene_firebase_auth-0.0.32.tar.gz
Algorithm Hash digest
SHA256 b53a5c377017488d0fd48ef011f45b84105f7137c86ab28d65ae3d83b9848df7
MD5 a8a0da409a5fa684f2103be634e900fc
BLAKE2b-256 f99254ad52818bb84f26284be1df79f30b2c59c80dd4ae4651be2870dc4db915

See more details on using hashes here.

File details

Details for the file django_graphene_firebase_auth-0.0.32-py3-none-any.whl.

File metadata

File hashes

Hashes for django_graphene_firebase_auth-0.0.32-py3-none-any.whl
Algorithm Hash digest
SHA256 aaf0678515cab6c9dd769aa3b260858830821d948cdc24647e62eec139276fe6
MD5 b23b31cfd3e2808feffc5030ae04018a
BLAKE2b-256 f26b63b05c5bfdfc179278c3e67cc81d89f35eab3506f641b1c14364ca75ada3

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