https://github.com/syndbg/django-github-oauth

An authentication backend for Github OAuth
https://github.com/syndbg/django-github-oauth

Last synced: 11 days ago
JSON representation

An authentication backend for Github OAuth

• Host: GitHub
• URL: https://github.com/syndbg/django-github-oauth
• Owner: syndbg
• License: mit
• Created: 2014-12-14T11:38:06.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2014-12-15T14:55:13.000Z (almost 10 years ago)
• Last Synced: 2023-05-13T23:25:17.380Z (over 1 year ago)
• Language: Python
• Size: 133 KB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Django Github OAuth

A backend to authenticate users in a Django web app using Github's OAuth.

![Unicorn](http://i.imgur.com/lvAH97u.png)

# Installation

via setuptools

```

python setup.py install

```

via PyPi

```

pip install django-github-oauth

```

# Usage

1. Add `github_oauth` in your `project/settings.py`'s INSTALLED apps.

```

INSTALLED_APPS = (

    'django.contrib.admin',

    'django.contrib.auth',

    'django.contrib.contenttypes',

    'django.contrib.sessions',

    'django.contrib.messages',

    'django.contrib.staticfiles',

    'github_oauth',

)

```

2. Add `github_oauth.authentication.GithubOAuthentication` to your auth backends.

```

AUTHENTICATION_BACKENDS = (

    'github_oauth.authentication.GithubOAuthentication',

)

```

3. Create a Github OAuth application. You can do so [here](https://github.com/settings/applications/new)

4. In your `project/settings.py` set the following variables from the newly created Github OAuth app:

* GITHUB_CLIENT_ID

* GITHUB_CLIENT_SECRET

* GITHUB_REDIRECT_URI

Copy-paste very carefully. :sweat_smile: