.. _ref-bbauth-gettingstarted:

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

This document is designed to get you up and running with
``pinax.apps.bbauth``...


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

These are the requirements to run ``pinax.apps.bbauth``:

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

These dependencies should be added to your ``requirements/project.txt`` file
and installed using pip_. For example::

    pip install -r requirements/project.txt


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

Add ``pinax.apps.bbauth`` to your ``INSTALLED_APPS``:

.. code-block:: python

    INSTALLED_APPS = [
        # ...
        "pinax.apps.bbauth",
    ]

Hook up ``pinax.apps.bbauth`` to your URLconf:

.. code-block:: python

    urlpatterns = patterns("",
        # ...
        url(r"^bbauth/", include("pinax.apps.bbauth.urls"))
    )

You should also `register your project`_ with Yahoo! to get the tokens you need for
the proper settings variables.


.. _pip: http://pip.openplans.org/
.. _register your project: http://developer.yahoo.com/auth/appreg.html