Skip to main content

Facebook accountkit support for Django

Project description

django-accountkit

Using Facebook accountkit with Django https://developers.facebook.com/products/account-creation

PyPI version Join the community on Spectrum

Overview

This package enables the use of Facebook Accountkit with Django authentication

If you want to know more about Facebook Accountkit, check out the following resources

Requirements

  • Python (>= 2.7 and <= 3.7)
  • Django (>=1.11)

Installation

Installation is easy using pip

pip install django-accountkit

Then to add Django Accountkit to your project add the app accountkitlogin to your INSTALLED_APPS.

Now add the following settings in your settings.py file

APP_ID = <Accountkit App ID>
ACCOUNT_KIT_APP_SECRET = <Accountkit App Secret>
ACCOUNT_KIT_VERSION = "v1.0"
ACCOUNT_KIT_SUCCESS_REDIRECT = <The URL for the page where user will land after authenticating> (Please Use absolute path only)
#Example ACCOUNT_KIT_SUCCESS_REDIRECT = "http://localhost:8000/success"

Then add the following in your settings.py file

AUTHENTICATION_BACKENDS = (
	'accountkitlogin.authenticate.GetOrCreateUser',
)

Using Accountkitlogin

View

To use Accountkit to authenticate your users import from accountkitlogin.views import login_status

Then in your view use login_status

@csrf_exempt
def success_page(request):
	context = login_status(request)

Note that csrf exempt is required because Facebook Accountkit will redirect the user to your success page url and this might throw a cross origin error

The login_status function accepts the request as parameter and returns a dictionary with

  • Key 'authenticated' True or False
  • Key 'message' A message related to whether the user is authenticated or not
  • Key 'user' Returns a user instance when 'authenticated' is True

Add the view to your urls.py file for the success_page url which you defined in ACCOUNT_KIT_SUCCESS_REDIRECT setting

Template Tags

Add {% load accountkit %} at the starting of your template and add the following template tags to your file where you want to display the login buttons

  1. Add (% accountkitjs %} inside your <head></head> tag
  2. Add {% accountkitform %} inside your <body></body> tag
  3. Add {% smslogin %} and/or {% emaillogin %} anywhere in you body section where you want to display your login buttons. Both these tags accept two parameters className and text where you can add your custom css classes and the text to display on the button. Example {% emaillogin "button" "Use the email" %}

Notes

Contribute

Please contribute to this repositiory :)

Author

This is project is inspired by

Project details


Download files

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

Files for django-accountkit, version 0.2.3
Filename, size File type Python version Upload date Hashes
Filename, size django_accountkit-0.2.3-py3-none-any.whl (7.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-accountkit-0.2.3.tar.gz (5.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page