Kadi-APY
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.
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.
Quickstart
Installation
The library can be installed using pip:
pip3 install kadi-apy
Note that Python version >=3.9 is required to install the latest version.
Configuration
To connect to an existing Kadi4Mat instance, some further configuration is required, which can be initialized by running:
kadi-apy config create
Simple Python example
Retrieve an existing record by its ID and upload a file to it:
from kadi_apy import KadiManager
manager = KadiManager()
record = manager.record(id=1)
record.upload_file("/path/to/file.txt")
Simple CLI example
Do the same as in the example above:
kadi-apy records add-files -r 1 -n /path/to/file.txt
Issues
For any issues regarding kadi-apy (bugs, suggestions, discussions, etc.) please
use the issue tracker of this
project. Before creating an issue, please make sure that no similar issue is
already open and that you are using the latest
release or the current version of the
master branch. Note that creating a new issue requires a GitLab account.
For bugs in particular, please use the provided Bug template when
creating an issue, which also adds the Bug label to the issue automatically.
Contributions
Contributions to the code are always welcome. In order to merge any contributions back into the main repository, please open a corresponding merge request. For instructions on how to set up a development environment, please see the documentation.
Further links
- Source code: https://gitlab.com/iam-cms/kadi-apy
- Releases: https://pypi.org/project/kadi-apy/
- Documentation:
- Latest release: https://kadi-apy.readthedocs.io/en/stable/
- Current state: https://kadi-apy.readthedocs.io/en/latest/
1 maintainer
Metadata
1 maintainer
Release files for kadi-apy 0.51.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kadi_apy-0.51.0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / kadi_apy-0.51.0-py3-none-any.whl
| Download URL | kadi_apy-0.51.0-py3-none-any.whl |
|---|---|
| Size | 90.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ad8f91acebd56914ce14780e5b8cbf2fd4b6240276550fa55df7effa51410ed2
|
|
BLAKE2b-256 checksum How to use checksums |
396cc6b424b07b3fa8eaac1ff224683b28d458ccbd0567e14dfa6a2ee2ff82d0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.14.3
|
