django-octocat 0.1.0

A Django app for handling github users and repos.

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'^app-url/', include('github.urls')),
)

Don’t forget to migrate your database

./manage.py migrate github

Usage

TODO: Describe usage or point to docs. Also describe available settings and templatetags.

Contribute

If you want to contribute to this project, please perform the following steps

mkvirtualenv django-octocat -r requirements.txt
python setup.py develop

Add code, write test, send pull request.

$ git add . && git commit $ git push -u origin feature_branch # Send us a pull request for your feature branch