Quick Start - Python SDK

Read a property from Poelis in Python. You need a Poelis account and an SDK key.

Install poelis-sdk

Terminal
Notebook

pip install -U poelis-sdk

!pip install -U poelis-sdk

Create a client

from poelis_sdk import PoelisClient

poelis_client = PoelisClient(api_key="YOUR_SDK_KEY")
poelis = poelis_client.browser

browser is the starting point for workspaces, products, items, and properties. Store the key in an environment variable or a password manager. See SDK keys.

Read a property

Dot notation follows readable IDs from the workspace down to the property:

mass = poelis.demo_workspace.demo_product.demo_item.demo_property_mass
print(mass.value, mass.category, mass.unit)

In a notebook, autocomplete fills in each level as you type. Replace the demo names with readable IDs from your own workspace.

Next steps

Browse your data

List workspaces, products, items, and properties

Product versions

Pin a calculation to baseline or a published version

Edit properties

Update draft values from Python

Notebooks and scripts

Explore in a notebook, then lock IDs into a script

Getting started

Guides

MATLAB

Quick Start - Python SDK

Next steps

Browse your data

Product versions

Edit properties

Notebooks and scripts

​Next steps

Browse your data

Product versions

Edit properties

Notebooks and scripts

Next steps