Metadata-Version: 2.1
Name: planqk-service-sdk
Version: 1.3.4
Summary: Python SDK to execute PlanQK Managed Services.
Home-page: https://docs.platform.planqk.de/sdk-reference.html
Author: Anaqor AG
Author-email: info@anaqor.io
License: apache-2.0
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# PlanQK Service SDK

## Installation

The package is published on PyPI and can be installed via `pip`:

```bash
pip install --upgrade planqk-service-sdk
```

## Usage

```python
from planqk.service.client import PlanqkServiceClient

consumer_key = "..."
consumer_secret = "..."
service_endpoint = "..."

client = PlanqkServiceClient(service_endpoint, consumer_key, consumer_secret)

# prepare your input data and parameters
data = {"input": {"a": 1, "b": 2}}
params = {"param1": "value1", "param2": "value2"}

# start the execution
job = client.start_execution(data=data, params=params)

# wait for the result
result = client.get_result(job.id)
```

## Development

To create a new Conda environment, run:

```bash
conda env create -f environment.yml
```

Then, to activate the environment:

```bash
conda activate planqk-service-sdk
```

To install the package in development mode, run:

```bash
pip install -e .
```


