.. _ref-gettingstarted:

===============
Getting started
===============

This document is designed to get you up and running with django-oauth-access.
This app is designed for use with Django_, however, can be used with Pinax_.
Pinax can provide some extra components which will enhance the functionality
of django-oauth-access. Those extra components are designed for Django too and
Pinax simply brings them together.


Prerequisites
=============

These are the requirements to run idios:

 * Python **2.4+** (Python 3.x is **not** supported yet)
 * Django **1.2+**


Installation
============

To install django-oauth-access use pip_:

.. code-block:: none

    pip install django-oauth-access

Add ``oauth_access`` to your ``INSTALLED_APPS``:

.. code-block:: python

    INSTALLED_APPS = [
        # ...
        "oauth_access",
    ]

Hook up oauth_access to your URLconf:

.. code-block:: python

    urlpatterns = patterns("",
        # ...
        url(r"^oauth/", include("oauth_access.urls"))
    )

This is largely all you need to do to get django-oauth-access setup in your
project. Continue reading on to learn more about how to use django-oauth-access.


Usage
=====

TODO

.. _Django: http://www.djangoproject.com/
.. _Pinax: http://pinaxproject.com/
.. _pip: http://pip.openplans.org/