Installation from source¶
Requirements¶
RestAuthClient is written as a bleeding edge project and thus requires relatively new software versions.
- Python 2.6 or later
- RestAuthCommon 0.6.1 or later
Get source¶
From git¶
This project is developed on git.fsinf.at. You can view the source code at git.fsinf.at/restauth/python. To clone the repository to a directory named “RestAuthClient”, simply do:
git clone http://git.fsinf.at/restauth/python.git RestAuthClient
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 (“RestAuthClient” in the above example) and run:
python setup.py build
python setup.py install
Note
On most systems, the latter command needs to run with superuser privileges.
You can verify that the installation worked by running this command from your home directory:
cd
python -c "import RestAuthClient"
This will throw an ImportError if RestAuthClient was not installed successfully.
Run tests¶
Warning
Running the test-suite or generating a test coverage support will remove all data from the running RestAuth server. Do not perform these tests on a live installation.
RestAuthClient features an extensive test suite. Since it implements a network protocol, the library
requires a RestAuth server to run on http://[::1]:8000
that has the service vowi
with the
password vowi
preconfigured. The RestAuth server contains the
script test.sh
in its source code to simply start a server and add the expected service.
After you started the server, you can run test-suite using:
python setup.py test
Test coverage¶
You can also generate a test coverage report using coverage.py using:
python setup.py coverage
By default, a pretty coverage report will go to doc/coverage/.
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