planqk-service-sdk

Name	planqk-service-sdk JSON
Version	1.9.0 JSON
	download
home_page	https://gitlab.com/planqk-foss/planqk-service-sdk/-/tree/main/python
Summary	Python SDK to execute PlanQK Managed Services.
upload_time	2024-11-08 07:16:35
maintainer	None
docs_url	None
author	Kipu Quantum GmbH
requires_python	>=3.9
license	apache-2.0
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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)

# check the job details
print(job.id, job.status)

# cancel the job
job.cancel()

# retrieve the job result
result = job.result()

# retrieve the job's interim results
interim_results = job.interim_results()
```

## 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 .
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.com/planqk-foss/planqk-service-sdk/-/tree/main/python",
    "name": "planqk-service-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Kipu Quantum GmbH",
    "author_email": "info@kipu-quantum.com",
    "download_url": "https://files.pythonhosted.org/packages/34/e5/67654325ecfe0661e87c3a04729904f98f5a58b0a47435f325f0eef5f1da/planqk_service_sdk-1.9.0.tar.gz",
    "platform": null,
    "description": "# PlanQK Service SDK\n\n## Installation\n\nThe package is published on PyPI and can be installed via `pip`:\n\n```bash\npip install --upgrade planqk-service-sdk\n```\n\n## Usage\n\n```python\nfrom planqk.service.client import PlanqkServiceClient\n\nconsumer_key = \"...\"\nconsumer_secret = \"...\"\nservice_endpoint = \"...\"\n\nclient = PlanqkServiceClient(service_endpoint, consumer_key, consumer_secret)\n\n# prepare your input data and parameters\ndata = {\"input\": {\"a\": 1, \"b\": 2}}\nparams = {\"param1\": \"value1\", \"param2\": \"value2\"}\n\n# start the execution\njob = client.start_execution(data=data, params=params)\n\n# check the job details\nprint(job.id, job.status)\n\n# cancel the job\njob.cancel()\n\n# retrieve the job result\nresult = job.result()\n\n# retrieve the job's interim results\ninterim_results = job.interim_results()\n```\n\n## Development\n\nTo create a new Conda environment, run:\n\n```bash\nconda env create -f environment.yml\n```\n\nThen, to activate the environment:\n\n```bash\nconda activate planqk-service-sdk\n```\n\nTo install the package in development mode, run:\n\n```bash\npip install -e .\n```\n",
    "bugtrack_url": null,
    "license": "apache-2.0",
    "summary": "Python SDK to execute PlanQK Managed Services.",
    "version": "1.9.0",
    "project_urls": {
        "Homepage": "https://gitlab.com/planqk-foss/planqk-service-sdk/-/tree/main/python"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9bcbba6f9074dfaf77df66cd8bfdb064a54d86c2919dd268132af6826cced526",
                "md5": "872ffae7e0c2741b5023525fe5d2146a",
                "sha256": "c25b5516de59fbba1a0f4489f472c3a61a5bac7f7e526f9fa12dba9a1f6bd926"
            },
            "downloads": -1,
            "filename": "planqk_service_sdk-1.9.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "872ffae7e0c2741b5023525fe5d2146a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 22668,
            "upload_time": "2024-11-08T07:16:33",
            "upload_time_iso_8601": "2024-11-08T07:16:33.901062Z",
            "url": "https://files.pythonhosted.org/packages/9b/cb/ba6f9074dfaf77df66cd8bfdb064a54d86c2919dd268132af6826cced526/planqk_service_sdk-1.9.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "34e567654325ecfe0661e87c3a04729904f98f5a58b0a47435f325f0eef5f1da",
                "md5": "f37d62ca4c2c03d51e34f43b11345418",
                "sha256": "ed62fcaf6d57989fd574214f86c1eeb065c0584d523dd6654f540a56739b1365"
            },
            "downloads": -1,
            "filename": "planqk_service_sdk-1.9.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f37d62ca4c2c03d51e34f43b11345418",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 12243,
            "upload_time": "2024-11-08T07:16:35",
            "upload_time_iso_8601": "2024-11-08T07:16:35.430205Z",
            "url": "https://files.pythonhosted.org/packages/34/e5/67654325ecfe0661e87c3a04729904f98f5a58b0a47435f325f0eef5f1da/planqk_service_sdk-1.9.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-08 07:16:35",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "planqk-foss",
    "gitlab_project": "planqk-service-sdk",
    "lcname": "planqk-service-sdk"
}