Installation from source¶
Requirements¶
- RestAuthCommon requires Python 2.6 or later. On Python3, RestAuthCommon is tested with Python 3.2 and later.
- Some ContentHandlers require, if used, additional libraries:
- The
XMLContentHandler
requires the lxml library. - The
YAMLContentHandler
requires the PyYAML library. - The
Pickle3ContentHandler
requires Python3.
- The
Get source¶
From git¶
This project is developed on git.fsinf.at. You can view the source code at git.fsinf.at/restauth/restauth-common. To clone the repository to a directory named “RestAuthCommon”, simply do:
git clone http://git.fsinf.at/restauth/restauth-common.git RestAuthCommon
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 <tag>. 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 of RestAuthCommon is very easy. Just go to the directory where your source is located (“RestAuthCommon” in the above example) and run:
python setup.py build
python setup.py install
Note
On most systems, the install
command requires superuser privileges.
You can verify that the installation worked by running this command from your home directory:
cd
python -c "import RestAuthCommon"
This will throw an ImportError if RestAuthCommon was not installed successfully.
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