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.0.2.tar.gz (60.0 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.0.2-py3-none-any.whl (125.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oqtopus_client-1.0.2.tar.gz
  • Upload date:
  • Size: 60.0 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.0.2.tar.gz
Algorithm Hash digest
SHA256 9bf05dfaca2f21bf84a022dcbe8d0ae6f6367e074725ede64aaaa0117d69e65e
MD5 f6a4914ce0a63de0b6711694619a2412
BLAKE2b-256 d494b827865abc5bc48a81b42ea987a3869b573b0124342ea7fad82e2ad227f8

See more details on using hashes here.

Provenance

The following attestation bundles were made for oqtopus_client-1.0.2.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.0.2-py3-none-any.whl.

File metadata

  • Download URL: oqtopus_client-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 125.1 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.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 80f974a854a7d79a115ac7d477bf69f74073b928861e4cfdcb656e0a4bca3dee
MD5 47fa6a11bf623446a6ae1446ef1626d3
BLAKE2b-256 f6bea6f4fe1bd34c4da069233cc191a12afd40a56c5e39f95a9b438476eee5e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for oqtopus_client-1.0.2-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