# Kadi-APY
**Kadi-APY** is a library for use in tandem with
[Kadi4Mat](https://gitlab.com/iam-cms/kadi "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:
```python
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:
```shell
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](https://gitlab.com/iam-cms/kadi-apy/-/issues) 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](https://pypi.org/project/kadi-apy/) 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](https://gitlab.com/iam-cms/kadi-apy/-/merge_requests). For
instructions on how to set up a development environment, please see the
[documentation](https://kadi-apy.readthedocs.io/en/latest).
## 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/
Raw data
{
"_id": null,
"home_page": null,
"name": "kadi-apy",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Karlsruhe Institute of Technology",
"author_email": null,
"download_url": null,
"platform": null,
"description": "# Kadi-APY\n\n**Kadi-APY** is a library for use in tandem with\n[Kadi4Mat](https://gitlab.com/iam-cms/kadi \"Kadi4Mat\"). The REST-like API of\nKadi4Mat makes it possible to programmatically interact with most of the\nresources that can be used through the web interface by sending suitable HTTP\nrequests to the different endpoints the API provides.\n\nThe goal of this library is to make the use of this API as easy as possible. It\noffers both an object oriented approach to work with the API in Python as well\nas a command line interface (CLI). The library is written in Python 3 and works\nunder both Linux and Windows.\n\n## Quickstart\n\n### Installation\n\nThe library can be installed using pip:\n\n`pip3 install kadi-apy`\n\nNote that Python version **>=3.9** is required to install the latest version.\n\n### Configuration\n\nTo connect to an existing Kadi4Mat instance, some further configuration is\nrequired, which can be initialized by running:\n\n`kadi-apy config create`\n\n### Simple Python example\n\nRetrieve an existing record by its ID and upload a file to it:\n\n```python\nfrom kadi_apy import KadiManager\n\nmanager = KadiManager()\n\nrecord = manager.record(id=1)\nrecord.upload_file(\"/path/to/file.txt\")\n```\n\n### Simple CLI example\n\nDo the same as in the example above:\n\n```shell\nkadi-apy records add-files -r 1 -n /path/to/file.txt\n```\n\n## Issues\n\nFor any issues regarding kadi-apy (bugs, suggestions, discussions, etc.) please\nuse the [issue tracker](https://gitlab.com/iam-cms/kadi-apy/-/issues) of this\nproject. Before creating an issue, please make sure that no similar issue is\nalready open and that you are using the latest\n[release](https://pypi.org/project/kadi-apy/) or the current version of the\n`master` branch. Note that creating a new issue requires a GitLab account.\n\nFor **bugs** in particular, please use the provided `Bug` template when\ncreating an issue, which also adds the `Bug` label to the issue automatically.\n\n## Contributions\n\nContributions to the code are always welcome. In order to merge any\ncontributions back into the main repository, please open a corresponding [merge\nrequest](https://gitlab.com/iam-cms/kadi-apy/-/merge_requests). For\ninstructions on how to set up a development environment, please see the\n[documentation](https://kadi-apy.readthedocs.io/en/latest).\n\n## Further links\n\n* Source code: https://gitlab.com/iam-cms/kadi-apy\n* Releases: https://pypi.org/project/kadi-apy/\n* Documentation:\n * Latest release: https://kadi-apy.readthedocs.io/en/stable/\n * Current state: https://kadi-apy.readthedocs.io/en/latest/\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "API wrapper library for Kadi4Mat",
"version": "0.45.0",
"project_urls": {
"Changelog": "https://gitlab.com/iam-cms/kadi-apy/-/blob/master/HISTORY.md",
"Documentation": "https://kadi-apy.readthedocs.io/en/stable",
"Source": "https://gitlab.com/iam-cms/kadi-apy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b929be4ae17d9a4b0fbd69ff2d879c5126a04d83076c8b3ac35ffe083534ed4d",
"md5": "7deef3ddce1768bb435de7ec61371484",
"sha256": "6ae271802e74d768617e78956e5c54c927f73df5856e2a61fe1a6935161421d0"
},
"downloads": -1,
"filename": "kadi_apy-0.45.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7deef3ddce1768bb435de7ec61371484",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.9",
"size": 84768,
"upload_time": "2024-12-05T10:28:20",
"upload_time_iso_8601": "2024-12-05T10:28:20.843867Z",
"url": "https://files.pythonhosted.org/packages/b9/29/be4ae17d9a4b0fbd69ff2d879c5126a04d83076c8b3ac35ffe083534ed4d/kadi_apy-0.45.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-05 10:28:20",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "iam-cms",
"gitlab_project": "kadi-apy",
"lcname": "kadi-apy"
}
JSON