Welcome to kadi-apy’s documentation!

PyPi License Zenodo

Kadi-APY is a library for use in tandem with Kadi4Mat. The REST-like API of Kadi4Mat makes it possible to programmatically interact with most of the resources that can be used through the web interface by sending suitable HTTP requests to the different endpoints the API provides. Detailed information about the API itself can be found in the developer documentation of Kadi4Mat.

The goal of this library is to make the use of this API as easy as possible. It offers both an object oriented approach to work with the API in Python as well as a command line interface (CLI). The library is written in Python 3 and works under both Linux and Windows.

This sections describes how to install, upgrade and configure the kadi-apy.

The library can be used by either directly importing it into any Python code or script or by using the command line interface (CLI). The library itself is divided into the sections kadi_apy.lib and kadi_apy.cli.lib. The former usually returns a response object as used in the requests library. The latter contains more advanced methods including error handling and print outputs.