Metadata-Version: 1.0
Name: django-octocat
Version: 0.2.1
Summary: A Django app for handling github users and repos.

Home-page: https://github.com/Celc/django-octocat
Author: Kit Sunde
Author-email: kitsunde.com
License: The MIT License
Description: Django Octocat
        ==============
        
        .. image:: https://api.travis-ci.org/Celc/django-octocat.png?branch=master
                :target: https://travis-ci.org/Celc/django-octocat
        
        .. image:: https://coveralls.io/repos/Celc/django-octocat/badge.png?branch=master
                :target: https://coveralls.io/r/Celc/django-octocat?branch=master
        
        .. image:: https://pypip.in/v/django-octocat/badge.png
                :target: https://crate.io/packages/django-octocat
        
        .. image:: https://pypip.in/d/django-octocat/badge.png
                :target: https://crate.io/packages/django-octocat
        
        A Django app for handling github users and repos.
        
        Installation
        ------------
        
        To get the latest stable release from PyPi
        
        .. code-block:: bash
        
            pip install django-octocat
        
        To get the latest commit from GitHub
        
        .. code-block:: bash
        
            pip install -e git+git://github.com/Celc/django-octocat.git#egg=github
        
        Add ``github`` to your ``INSTALLED_APPS``
        
        .. code-block:: python
        
            INSTALLED_APPS = (
                ...,
                'github',
            )
        
        Add the ``github`` URLs to your ``urls.py``
        
        .. code-block:: python
        
            urlpatterns = patterns('',
                ...
                url(r'^github/', include('github.urls', namespace='github')),
            )
        
        Add ``github.middlewares.GithubAuthorizationMiddleware`` to your
        ``MIDDLEWARE_CLASSES``
        
        .. code-block:: python
        
            MIDDLEWARE_CLASSES = (
                ...
                'github.middlewares.GithubAuthorizationMiddleware',
            )
        
        Add ``github.backends.GithubBackend`` to your ``AUTHENTICATION_BACKENDS``
        
        .. code-block:: python
        
            AUTHENTICATION_BACKENDS = (
                ...
                'github.backends.GithubBackend',
            )
        
        Don't forget to migrate your database
        
        .. code-block:: bash
        
            ./manage.py migrate github
        
        If you are planning on cloning the repos set the target directory in
        ``settings.py``
        
        .. code-block:: python
        
            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
        ----------
        
        .. code-block:: bash
        
            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.
        
Keywords: django,app,reusable,github,git
Platform: OS Independent
