kelvin-rest-api-client 0.2.0

Python library to interact with the UCS@school Kelvin REST API.

Python UCS@school Kelvin REST API Client

Python library to interact with the UCS@school Kelvin REST API.

• Free software: GNU Affero General Public License version 3

• Documentation: https://kelvin-rest-api-client.readthedocs.io

Features

• Asynchronous

• Automatic handling of HTTP(S) sessions

• Type annotations

• 90% test coverage (unittests + integration tests)

• Python 3.7, 3.8, 3.9

Usage

The Session context manager opens and closes a HTTP session:

>>> import asyncio
>>> from ucsschool.kelvin.client import Session, User, UserResource
>>>
>>> async def get_user(username: str) -> User:
...     async with Session(
...         "USERNAME",
...         "PASSWORD",
...         "master.ucs.local",
...         verify="ucs-root-ca.crt"
...     ) as session:
...         return await UserResource(session=session).get(name=username)
...
>>> obj = asyncio.run(get_user("demo_student"))
>>>
>>> print(obj)
User('name'='test_user', dn='uid=test_user,cn=schueler,cn=users,ou=DEMOSCHOOL,dc=example,dc=com')
>>> print(obj.firstname, obj.lastname)
Test User

There are more examples in the docs usage section.

For HTTPS to work, the SSL CA of the target system (UCS Master) must either be publicly signed, installed on the client system or available as file (as in the example above). If the SSL CA certificate is not available verify=False. Obviously that is not safe! The CA of any UCS server can always be downloaded from http://FQDN.OF.UCS/ucs-root-ca.crt.

Installation

Install UCS@school Kelvin REST API Client via pip from PyPI:

$ pip install kelvin-rest-api-client

Tests

There are some isolated unittests, but most tests run against a real UCS@school Kelvin REST API. .. A UCS Docker container is used for this. The Makefile automates downloading and starting the Docker container (1 GB) and running the tests.

The tests expect the existence of two schools (OUs) on the target system (the Kelvin API does not support creation of schools yet). The schools are DEMOSCHOOL and DEMOSCHOOL2. The first one usually already exists, but trying to create it again will is safe. To create the schools run on the system with the Kelvin API:

$ /usr/share/ucs-school-import/scripts/create_ou DEMOSCHOOL
$ /usr/share/ucs-school-import/scripts/create_ou DEMOSCHOOL2

Run tests with current Python interpreter:

$ make test

Using tox the tests can be executed with all supported Python versions:

$ make test-all

To use an existing UCS server for the tests, copy the file tests/test_server_example.yaml to tests/test_server.yaml and adapt the settings before starting the tests:

$ cp tests/test_server_example.yaml tests/test_server.yaml
$ $EDITOR tests/test_server.yaml
# check settings with a single test:
$ python -m pytest tests/test_user.py::test_get
# if OK, run all tests:
$ make test

Logging

Standard logging is used for tracking the libraries activity. To capture the log messages for this project, subscribe to a logger named ucsschool.kelvin.client. Attention: Passwords and session tokens will be logged at log level DEBUG!

The UCS@school Kelvin REST API on the UCS server logs into the file /var/log/univention/ucsschool-kelvin-rest-api/http.log. The UDM REST API on the UCS server logs into the file /var/log/univention/directory-manager-rest.log.

Repo permissions

• Github: @dansan and @JuergenBS

• Gitlab: @JuergenBS

• PyPI: @dansan and @SamuelYaron

• RTD: @dansan and @SamuelYaron

Credits

History

0.2.0 (2020-04-17)

• move tox to test requirements

• fix user object creation with default parameters

• change ‘as_dict’ to be a method instead of a property

• fix flaky tests

• improve test coverage

• pass more env args to tox

• fix AttributeError with repr(role)

• add complete usage documentation

0.1.0 (2020-04-16)

• First release.