Setup

The Exabel Python SDK is published on PyPI. This page covers installation and the two supported authentication methods.

Installation

pip install exabel

See the installation instructions for more info.

Authentication

The SDK supports two credential types. Access app.exabel.com/account to retrieve them.

📘

Which should you use?

If you are running scheduled or production code, use an API key — it survives across users and is the right credential for CI and pipelines. For ad-hoc analysis in a notebook or a local script, use an access token.

Authenticating with an API key

Set the API key as an environment variable:

export EXABEL_API_KEY="..."

The SDK and every python -m exabel.scripts.* command will pick it up automatically. To pass the key explicitly on the command line, use --api-key:

python -m exabel.scripts.<script> --api-key "..."  ...

In Python:

from exabel import ExabelClient

client = ExabelClient(api_key="...")
# or, with EXABEL_API_KEY set in the environment:
client = ExabelClient()

Authenticating with an access token

Similarly, the access token can be used like this:

export EXABEL_ACCESS_TOKEN="..."
# or
python -m exabel.scripts.<script> --access-token "..." ...

In Python:

from exabel import ExabelClient
# or, with EXABEL_ACCESS_TOKEN set in the environment:
client = ExabelClient(access_token="...")