Cognite Toolkit

0.8.62 verified Fri May 01 auth: no python

Official Cognite Data Fusion tool for managing project templates and configuration deployment. Current version 0.8.62, actively maintained and released weekly.

pip install cognite-toolkit

Common errors

error ModuleNotFoundError: No module named 'cognite_toolkit' ↓

cause The PyPI package is named 'cognite-toolkit' (with a hyphen), but import uses underscore. Also, Python PyPI package name is 'cognite-toolkit' but module is 'cognite_toolkit'.

fix

Install via pip install cognite-toolkit and import as from cognite_toolkit import ToolkitClient.

error AttributeError: module 'cognite_toolkit' has no attribute 'ToolkitClient' ↓

cause Using `import cognite_toolkit` and then accessing `cognite_toolkit.ToolkitClient`. The correct import is `from cognite_toolkit import ToolkitClient`.

fix

Use from cognite_toolkit import ToolkitClient.

error cognite_toolkit.exceptions.CogniteToolkitError: Invalid configuration: 'default_env' is not a valid field ↓

cause Using the deprecated `default_env` field in `cdf.toml` instead of `default_config_yaml`.

fix

Rename default_env to default_config_yaml in your cdf.toml.

Warnings

breaking The old top-level import `import cognite_toolkit` does not expose `ToolkitClient`. You must use `from cognite_toolkit import ToolkitClient` from version 0.7.0 onward. ↓

fix Use `from cognite_toolkit import ToolkitClient` instead of `import cognite_toolkit`.

deprecated The argument `default_env` in `cdf.toml` is deprecated; use `default_config_yaml` instead. ↓

fix Replace `default_env` with `default_config_yaml` in your `cdf.toml`.

gotcha Using `--credentials` on the command line with an explicit `CLIENT_ID` and `CLIENT_SECRET` may expose secrets in shell history. Prefer environment variables `CDF_CLIENT_ID`, `CDF_CLIENT_SECRET`. ↓

fix Set `CDF_CLIENT_ID` and `CDF_CLIENT_SECRET` environment variables instead of passing them as flags.

gotcha When deploying RAW databases, a misconfigured `Database.yaml` or `Table.yaml` with unsupported fields will cause the entire file to be skipped silently (since 0.8.58). No error message is shown. ↓

fix Validate your YAML files against the expected schema before deployment.

Imports

ToolkitClient
wrong
```
import cognite_toolkit
```
correct
```
from cognite_toolkit import ToolkitClient
```
The main client is not a top-level module; direct import of package does not expose ToolkitClient.

Quickstart

Initialize a ToolkitClient and check the connection status.

from cognite_toolkit import ToolkitClient
import os

client = ToolkitClient(
    base_url=os.environ.get('CDF_BASE_URL', 'https://api.cognitedata.com'),
    project=os.environ.get('CDF_PROJECT', 'my-project'),
    api_key=os.environ.get('CDF_API_KEY', '')
)
print(client.status())