Skip to main content

No project description provided

Project description

ConductorQuantum Python Library

fern shield pypi

The ConductorQuantum Python library provides convenient access to the ConductorQuantum API from Python.

Installation

pip install conductorquantum

Usage

Instantiate and use the client with the following:

from conductorquantum import ConductorQuantum

client = ConductorQuantum(
    token="YOUR_TOKEN",
)
client.models.execute(
    model="coulomb-blockade-peak-detector",
)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API.

import asyncio

from conductorquantum import AsyncConductorQuantum

client = AsyncConductorQuantum(
    token="YOUR_TOKEN",
)


async def main() -> None:
    await client.models.execute(
        model="coulomb-blockade-peak-detector",
    )


asyncio.run(main())

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

from conductorquantum.core.api_error import ApiError

try:
    client.models.execute(...)
except ApiError as e:
    print(e.status_code)
    print(e.body)

Advanced

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retriable when any of the following HTTP status codes is returned:

  • 408 (Timeout)
  • 429 (Too Many Requests)
  • 5XX (Internal Server Errors)

Use the max_retries request option to configure this behavior.

client.models.execute(..., {
    "max_retries": 1
})

Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

from conductorquantum import ConductorQuantum

client = ConductorQuantum(
    ...,
    timeout=20.0,
)


# Override timeout for a specific method
client.models.execute(..., {
    "timeout_in_seconds": 1
})

Custom Client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx
from conductorquantum import ConductorQuantum

client = ConductorQuantum(
    ...,
    httpx_client=httpx.Client(
        proxies="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

conductorquantum-0.0.10.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

conductorquantum-0.0.10-py3-none-any.whl (28.0 kB view details)

Uploaded Python 3

File details

Details for the file conductorquantum-0.0.10.tar.gz.

File metadata

  • Download URL: conductorquantum-0.0.10.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.8.18 Linux/5.15.0-1071-azure

File hashes

Hashes for conductorquantum-0.0.10.tar.gz
Algorithm Hash digest
SHA256 12e59b1f5022ffc48357a7e9df1d508ba109f05bce2838b9950b1784ca3aca6d
MD5 90caf5f4e6ce62573726b9fd333e4fef
BLAKE2b-256 0e4ab0ef14cd1d854a87da586b98d0d8c7cb7fc3d6b35f6110f3e8aeb1f29864

See more details on using hashes here.

File details

Details for the file conductorquantum-0.0.10-py3-none-any.whl.

File metadata

  • Download URL: conductorquantum-0.0.10-py3-none-any.whl
  • Upload date:
  • Size: 28.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.8.18 Linux/5.15.0-1071-azure

File hashes

Hashes for conductorquantum-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 23365032a29fc626cbb5d6a9adb14bafef35dfbed098230812272a5fa4c56855
MD5 f546d87034adbf67588b0fa34b01567e
BLAKE2b-256 ff5f8f92d774c5459bf3d3b5a9080b51f1b89427976883f4c577d2acb7a984c7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page