Local setup¶

Before you can invoke a service from the Opaque platform, you need to set up your local environment and install the Opaque Python SDK.

Prerequisites¶

To use services in Opaque, you’ll need:

Python 3.10 or higher
oras installed (for pulling the Opaque SDK package; see installation guide)
Access to the Opaque Python SDK (provided by Opaque)

Step 1. Check your Python version¶

Open a terminal and run:

python3 --version

If Python is not installed or the version is lower than 3.10, download the latest version from python.org/downloads.

For Linux users, run:

sudo apt install python3 python3-pip

Once Python is installed, you’re ready to install the SDK.

Step 2. Install the Opaque SDK¶

After confirming that Python is installed, the next step is to install the Opaque SDK. The SDK allows you to connect to your deployed workflows and invoke them programmatically from your local environment.

Important: The SDK version must match the version of your Opaque deployment.

To check your Opaque deployment version, you can look in either of two places:

On the sign-in page, just below the Login button.
At the bottom of any page once you're signed in to the app.

The version is displayed in the format Opaque vx.x.x (for example, Opaque v2.3.0).

To check your deployment version, go to your Opaque sign-in page and look just below the Login button. The version is displayed in the format Opaque vx.x.x (e.g., Opaque v2.3.0).

Once you’ve identified the correct version, export it as an environment variable:

export OPAQUE_VERSION=<OPAQUE_VERSION>

Then pull and install the SDK package from the Opaque OCI registry:

oras pull registry.corp.tooling.opaque-int.com/opaque-systems/opaque-python-sdk:$OPAQUE_VERSION
unzip opaque-python-package.zip
pip install opaque-<OPAQUE_VERSION>.tar.gz

When installed successfully, you should see: Successfully installed opaque-x.x.x (where x.x.x reflects your installed version, such as 2.3.0).

The SDK is now ready for use and you can start using services.