Skip to main content

Python SDK for OQTOPUS Cloud User API

Project description

OQTOPUS logo

OQTOPUS Client

CI pypi version Python versions GitHub release Documentation Status License slack DOI

Python client library for the OQTOPUS Cloud User API.

Overview

OQTOPUS Client is a Python SDK for the OQTOPUS Cloud User API.

It is designed for users who want to submit, monitor, and retrieve quantum jobs from Python without handling raw HTTP requests directly. The library provides a synchronous public API for ease of use, while handling network communication asynchronously inside the client.

The SDK covers both low-level API access and higher-level convenience helpers. You can work directly with typed request/response models when you need explicit control, or use helpers such as OqtopusJobSpec, run_*, and typed result wrappers for a more concise workflow.

Features

  • Typed Python access to the OQTOPUS Cloud User API.
  • Job submission helpers for sampling, estimation, multi-manual, and SSE (Server-Side Execution) workflows.
  • Job lifecycle operations such as submit, wait, status, cancel, and delete.
  • Typed result wrappers and generated Pydantic models.
  • Configuration via config files, environment variables, or explicit OqtopusConfig.
  • Built-in retry and backoff controls.

Documentation

Citation

You can use the DOI to cite OQTOPUS in your research.

DOI

Citation information is also available in the CITATION file.

Contact

You can contact us by creating an issue in this repository or by email:

License

OQTOPUS Client is released under the Apache License 2.0.

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

oqtopus_client-1.1.1.tar.gz (63.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

oqtopus_client-1.1.1-py3-none-any.whl (128.7 kB view details)

Uploaded Python 3

File details

Details for the file oqtopus_client-1.1.1.tar.gz.

File metadata

  • Download URL: oqtopus_client-1.1.1.tar.gz
  • Upload date:
  • Size: 63.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for oqtopus_client-1.1.1.tar.gz
Algorithm Hash digest
SHA256 a26014cfd015016760b3a169cbc6d8bb5268506dabff87db39618759a44f8f09
MD5 2937f0bf8413a4441f95e176f8afc9ba
BLAKE2b-256 bb0a4dd9f0965fa665047001e922dfd0a8a2c8fe09b4dcfde868e6c812d01a0c

See more details on using hashes here.

Provenance

The following attestation bundles were made for oqtopus_client-1.1.1.tar.gz:

Publisher: python-publish.yaml on oqtopus-team/oqtopus-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file oqtopus_client-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: oqtopus_client-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 128.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for oqtopus_client-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9e6ee5a7eaf9f305ac2f4fc841551f1d176837fd8f525674ae96e62dffd83329
MD5 7ae3ca6d7ae49ca59bd0e7ccb999940e
BLAKE2b-256 42299e0dea0ea33be725b3b715b257260d1c278c2581c4996e352fd8451dec68

See more details on using hashes here.

Provenance

The following attestation bundles were made for oqtopus_client-1.1.1-py3-none-any.whl:

Publisher: python-publish.yaml on oqtopus-team/oqtopus-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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