Welcome to RestAuthClient's documentation!
==========================================

Welcome to the homepage of **RestAuthClient**, a client library for `RestAuth
<https://restauth.net>`_. The library allows systems to share user authentication,
authorization and preferences on a `RestAuth server <https://restauth.net/wiki/Servers>`_. The
*RestAuthClient* library hides all protocol and network details from the programmer, enabling fast,
efficient and easy-to-maintain integration into existing services.

**RestAuthClient** is the client reference implemenation of the `RestAuth protocol
<https://restauth.net/Specification>`_ and is written in pure `Python <http://www.python.org>`_,
it requires Python 2.6 or later and is fully compatible with Python 3. **RestAuthClient** is free
software and is licenced under the `GNU General Public Licence, version 3
<http://www.gnu.org/licenses/gpl.html>`_, so please feel free to :doc:`contribute </contribute>`. 

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

.. toctree::
   :maxdepth: 1

   install/from-source
   install/debian-ubuntu
   
Guide
=====

.. toctree::
   :maxdepth: 1

   intro

API documentation
=================

.. toctree::
   :maxdepth: 1

   common
   restauth_user
   group
   errors

Further resources
=================
* `bugtracker <https://redmine.fsinf.at/projects/restauth-python>`_
* `git repository <http://git.fsinf.at/restauth/python>`_
* Jabber/XMPP chat: ``rest@conference.jabber.at``

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


