Skip to main content

Strangeworks Python SDK

PyPI version

View Documentation

This package is responsible for handling authentication, fetching jobs and backends, transferring files, and calling product endpoints. It's a dependency of most Strangeworks product-specific Python packages, including Qiskit, Rigetti pyQuil, Amazon Braket, and more.

Installation​

To get started, make sure you have Python 3.10 or above (installation) and are familiar with setting up and using virtual environments. You can easily install the Strangeworks SDK from PyPI with pip:

pip install strangeworks

Authentication​

To access the Strangeworks API, you'll need your API key, which you can find in the Strangeworks Portal on the home page. Once you have it, simply authenticate like so:

import strangeworks

strangeworks.authenticate(
    api_key="your-api-key" 
)
Multiple Workspaces?

If you belong to multiple Workspaces, please be aware your API keys are different for each.

Usage​

While you can use this package directly, it's most commonly used as a dependency of task-specific packages like Qiskit, Rigetti pyQuil, and Amazon Braket. You can find documentation for each of these packages on their product pages.

Not sure where to start?​

If you're new to quantum computing development, we recommend starting with Qiskit. It's one of the most popular open source frameworks for quantum computing.