Skip to main content

A Django app for handling github users and repos.

Project description

https://api.travis-ci.org/Celc/django-octocat.png?branch=master https://coveralls.io/repos/Celc/django-octocat/badge.png?branch=master https://pypip.in/v/django-octocat/badge.png https://pypip.in/d/django-octocat/badge.png

A Django app for handling github users and repos.

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.

Project details


Release history Release notifications

This version
History Node

0.2.1

History Node

0.2.0

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
django-octocat-0.2.1.tar.gz (12.6 kB) Copy SHA256 hash SHA256 Source None Oct 6, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page