.. highlight:: shell

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


Stable release
--------------

To install *Python UCS\@school Kelvin REST API Client*, run this command in your terminal:

.. code-block:: console

    $ pip install kelvin-rest-api-client

This is the preferred method to install *Python UCS\@school Kelvin REST API Client*, as it will always install the most recent stable release.
The major and the minor version of the *Python UCS\@school Kelvin REST API Client* must be at least as high as the version of the *UCS\@school Kelvin REST API*
which is used. The patch level may differ.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


From sources
------------

The sources for *Python UCS\@school Kelvin REST API Client* can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/univention/kelvin-rest-api-client

Or download the `tarball`_:

.. code-block:: console

    $ curl -OL https://github.com/univention/kelvin-rest-api-client/tarball/master

Once you have a copy of the source, you can install it (after unpacking) with:

.. code-block:: console

    $ python setup.py install


.. _Github repo: https://github.com/univention/kelvin-rest-api-client
.. _tarball: https://github.com/univention/kelvin-rest-api-client/tarball/master