Note: SDK installs with the CLI and is pre-installed if you are using Onepanel's Workspaces.

To install Onepanel's Python SDK via pip:

pip install -U onepanel

Note: The SDK is compatible with Python 2.7.x and Python >= 3.6.x, if you have both versions installed, you will need to use pip3 for Python >= 3.6.x.


You will first need to login with the CLI as mentioned in CLI Authentication.

After successful login, you can instantiate the SDK client as follows:

from onepanel.sdk import Client

# with username/access_token
client = Client(username='', access_token='')

# or with email/access_token
client = Client(email='', access_token='')


See Example Jupyter notebook to get started.

Did this answer your question?