API Client

This python package is used to interact with the QCI Connect platform of the German Aerospace Center (DLR). It is a component of the full QCI Connect SDK.

Documentation

You can find the documentations here.

The documentation files are also included in the source and can be built with the script dev_tools/build_docs.

Quick Start (Pip Installation)

• Run pip install qciconnect-client
• Take a look at the example notebooks

Working on Source Code (Dev Mode)

Clone the repository (or download the .tar.gz file), initialize the git submodules, then install dependencies.

We recommend using ultraviolet (installation guide).

git submodule update --init
uv sync
git submodule foreach "uv pip install -e ."

This installs API Client, its runtime dependencies, the dev/test dependencies, and the QCIConnect submodules as editable local dependencies. Recursive submodule initialization is not required.

You can now activate the .venv in the source directory or use uv to run commands in the .venv, e.g.,
uv run python my_script.py. Any time uv sync is necessary, script is available within the environment to perform this action and, at the same time, reinstall the submodules. The script can be executed as

update-venv

If you want to recreate the OpenAPI Wrapper from openapi.yml, run

npx @openapitools/openapi-generator-cli@2.23.4 generate