===============
python-webuntis
===============

.. image:: https://travis-ci.org/untitaker/python-webuntis.png?branch=master
   :target: https://travis-ci.org/untitaker/python-webuntis


Bindings for WebUntis API
=========================

::

    import webuntis

    s = webuntis.Session(
        username='api',
        password='api',
        server='webuntis.grupet.at:8080',
        school='demo_inf'
    ).login()

    for klasse in s.klassen():
        print(klasse.name)

`read more... `_

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

Latest version (this is the normal way)
+++++++++++++++++++++++++++++++++++++++

::

    pip install webuntis


Development
===========

Installing Development Dependencies
+++++++++++++++++++++++++++++++++++

A `virtualenv `_ is recommended::

    $ pip install -r dev_requirements.txt


Unittests
+++++++++

::

    $ pytest

For the single testsuites and their descriptions, look at the docstrings of the
modules in ``webuntis.tests``.