Installation

Requirements

• Python 3.12 or later

• A valid Ionworks API key (see Authentication)

Install from PyPI

Install the package using pip:

pip install ionworks

Or with uv:

uv pip install ionworks

ionworks cannot share an environment with the older ionworks-api package. See Migrating to ionworks if you are upgrading.

Verify the installation

Check that the package is installed correctly:

import ionworks as iw

print(iw.__version__)

Next steps

Once installed, head to Authentication to configure your API credentials.