Metadata-Version: 2.1
Name: mqp-client
Version: 0.1.2
Author-Email: mqss <mqss@munich-quantum-valley.de>
License: Apache-2.0
Requires-Python: >=3.8
Requires-Dist: requests>=2.31.0
Requires-Dist: python-decouple>=3.8
Requires-Dist: mypy>=1.10.1; extra == "dev"
Requires-Dist: pylint>=3.2.5; extra == "dev"
Requires-Dist: isort>=5.13.2; extra == "dev"
Requires-Dist: black>=24.4.2; extra == "dev"
Requires-Dist: pytest>=8.3.2; extra == "dev"
Provides-Extra: dev
Description-Content-Type: text/markdown

## Installation

```bash
pip install mqp-client
```

## Usage

```python
from mqp.client import MQPClient

URL = "<mqp-api-url>"
TOKEN = "<your-mqp-token>"

# create a client instance
client = MQPClient(token=TOKEN, url=URL)

# check out all the resources
resources = client.resources()
# get information about one specific resource
resource = client.resource_info(resource_name="<name-of-resource")

# send a job to the resource
qasm_circuit = "QASM 2.0; ...."
job_id = client.submit_job(resource_name="...", circuit=qasm_circuit, shots=1000)
# query the job's status
status = client.status(job_id)
# cancel the job
client.cancel(job_id)
# get the jobs result (returns None if job not finished yet)
result = client.result(job_id)
# wait for the result to come
result = client.wait_for_result(job_id)
```
