Installation

To get the latest stable release from PyPi

pip install django-octocat

To get the latest commit from GitHub

pip install -e git+git://github.com/Celc/django-octocat.git#egg=github

Add github to your INSTALLED_APPS

INSTALLED_APPS = (
    ...,
    'github',
)

Add the github URLs to your urls.py

urlpatterns = patterns('',
    ...
    url(r'^github/', include('github.urls', namespace='github')),
)

Add github.middlewares.GithubAuthorizationMiddleware to your MIDDLEWARE_CLASSES

MIDDLEWARE_CLASSES = (
    ...
    'github.middlewares.GithubAuthorizationMiddleware',
)

Add github.backends.GithubBackend to your AUTHENTICATION_BACKENDS

AUTHENTICATION_BACKENDS = (
    ...
    'github.backends.GithubBackend',
)

Don’t forget to migrate your database

./manage.py migrate github

If you are planning on cloning the repos set the target directory in settings.py

import tempfile
GITHUB_ROOT = tempfile.gettempdir()

Finally add the Github settings under /admin.

Usage

To authenticate users send them to {% url 'github:authorize' pk=1 %} where pk is the id of the Github app.

Contribute

mkvirtualenv django-octocat
make develop

Add code, write test, send pull request.

Octocat

Octocat is a trademark owned by GitHub Inc and is used with permission. The library is in no way affiliated, maintained or sponsored by GitHub Inc.