Metadata-Version: 2.4
Name: qciconnect-client
Version: 1.1.1
Summary: An API client to work with the DLR QCI Connect quantum computing platform.
Keywords: quantum computing,API client,QCI Connect
Author: DLR-SC, David da Costa, Thomas Keitzl, Elisabeth Lobe, Johannes Renkl, Gary Schmiedinghoff, Thomas Stehle, Lukas Windgätter
Author-email: DLR-SC <qc-software@dlr.de>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Operating System :: OS Independent
Requires-Dist: qciconnect-common>=0.2.2
Requires-Dist: httpx>=0.28.1,<0.29
Requires-Dist: pydantic>=2.10.6,<3
Requires-Dist: tabulate>=0.9.0,<0.10
Requires-Dist: numpy>=2.0.0,<3
Requires-Dist: typeguard>=4.4.4
Requires-Python: >=3.12
Description-Content-Type: text/markdown

[<img src="https://gitlab.com/dlr-sc-qc/qciconnect-sdk/commons/-/raw/main/docs/_static/logo_sdk.svg" alt="QCI Connect SDK" height="100"/>](https://dlr-sc-qc.gitlab.io/qciconnect-sdk/landing-page/) &nbsp;
[<img src="https://gitlab.com/dlr-sc-qc/qciconnect-sdk/api-client/-/raw/main/docs/_static/logo.png" alt="API Client Documentation" height="100"/>](https://dlr-sc-qc.gitlab.io/qciconnect-sdk/api-client/)

# API Client

This python package is used to interact with the [QCI Connect](https://qci.dlr.de/connect/) platform of the [German Aerospace Center (DLR)](https://www.dlr.de/).
It is a component of the full [QCI Connect SDK](https://pypi.org/project/qciconnect/).

## Documentation

You can find the documentations [here](https://dlr-sc-qc.gitlab.io/qciconnect-sdk/api-client/).

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](https://dlr-sc-qc.gitlab.io/qciconnect-sdk/api-client/examples.html)

## 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](https://docs.astral.sh/uv) ([installation guide](https://docs.astral.sh/uv/getting-started/installation/#installation-methods)).

```bash
git submodule update --init
uv sync
```
You can now [activate](https://docs.python.org/3/library/venv.html#how-venvs-work) the `.venv` in the source directory or use uv to run commands in the `.venv`, e. g.,  `uv run python my_script.py`.