Installation from source¶
Requirements¶
RestAuth has the following requirements:
- Python 2.6.5 or later or Python 3.2 or later
- Django 1.4.2 or later - RestAuth is written as a Django project
- Any database supported by Django that supports transactions
- 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.
Note
Although Django 1.4 still supports Python 2.5, RestAuth is only compatible with Python 2.6.5 or later. Earlier 2.6-versions should also work but are untested.
Get source¶
From git¶
This project is developed on git.fsinf.at. You can view the source code at git.fsinf.at/restauth/server. To clone the repository to a directory named “RestAuth”, simply do:
git clone http://git.fsinf.at/restauth/server.git RestAuth
Note
A mirror of this git-repository is available on github.
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 1.0. 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
... and do the same as if you where doing a new installation.
Installation¶
Installation itself is very easy. Just go to the directory where your source is located (“RestAuth” in the above example) and run:
python setup.py build
python setup.py install
Once you have installed RestAuth, you can go on configuring your webserver and configuring RestAuth.
Next steps¶
Now that you have installed RestAuth, you still need to
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.
Updating the source¶
To update the source code, just run:
python setup.py clean
git pull
After you updated the source, don’t forget to update your database schema and check for new settings.