Installation from source

Requirements

RestAuth has the following requirements:

  • Python 2.6.5 or later or Python 3.2 or later
  • Django 1.6 or later - RestAuth is written as a Django project
  • Any database supported by Django that supports transactions, see the DATABASES setting.
  • RestAuthCommon 0.6.2 or later
  • mimeparse 0.1.4 or later
  • The argparse module ships with Python 2.7 and is available for Python 2.6
  • Django South is used for handeling schema migrations.

Additionally, various optional features require additional libraries:

Get source from git

This project is developed on GitHub. To clone the repository into the RestAuth directory, simply do:

git clone https://github.com/RestAuth/server.git RestAuth

Older versions are marked as tags. You can view available tags with git tag -l. You can use any of those versions with git checkout, for example git checkout 0.6.3. To move back to the newest version, use git checkout master.

If you ever want to update the source code, just use:

python setup.py clean
git pull origin master

... and be sure to follow the update instructions.

Download official releases

You can download official releases of RestAuth here. The latest release is version 0.6.4.

Installation

There isn’t really anything you have to do besides downloading the source code. To configure RestAuth, copy RestAuth/RestAuth/localsettings.py.example to RestAuth/RestAuth/localsettings.py and edit it to your needs. The wsgi-script is located at RestAuth/RestAuth/wsgi.py, be sure to include the path of your download directory in the PYTHONPATH of your WSGI-server.

Next steps

Now that you have installed RestAuth, you still need to

  1. configure your webserver
  2. configure RestAuth
  3. setup your database

Run tests

RestAuth features an extensive test suite. You can run those tests using:

python setup.py test

Note that you can run these tests even if you already installed RestAuth or locally configured your RestAuth installation. The tests will always use their own temporary database.

Build documentation

To generate the most recent documentation (the newest version of the document you’re currently reading), just run:

python setup.py build_doc

Note

You can build documentation customized for a specific distribution with:

python setup.py build_doc -t debian

This will customize various paths, binary names etc. for what is used in the respective distribution.

Table Of Contents

Previous topic

Welcome to RestAuth!

Next topic

Installation with pip

This Page