{"id":23441,"library":"cognite-toolkit","title":"Cognite Toolkit","description":"Official Cognite Data Fusion tool for managing project templates and configuration deployment. Current version 0.8.62, actively maintained and released weekly.","status":"active","version":"0.8.62","language":"python","source_language":"en","source_url":"https://github.com/cognitedata/toolkit","tags":["cognite","cdf","toolkit","deployment","configuration"],"install":[{"cmd":"pip install cognite-toolkit","lang":"bash","label":"Latest release"}],"dependencies":[{"reason":"Core SDK for Cognite Data Fusion API","package":"cognite-sdk","optional":false},{"reason":"YAML parsing for configuration files","package":"pyyaml","optional":false},{"reason":"Terminal output formatting","package":"rich","optional":false},{"reason":"HTTP requests for API calls","package":"requests","optional":false}],"imports":[{"note":"The main client is not a top-level module; direct import of package does not expose ToolkitClient.","wrong":"import cognite_toolkit","symbol":"ToolkitClient","correct":"from cognite_toolkit import ToolkitClient"}],"quickstart":{"code":"from cognite_toolkit import ToolkitClient\nimport os\n\nclient = ToolkitClient(\n    base_url=os.environ.get('CDF_BASE_URL', 'https://api.cognitedata.com'),\n    project=os.environ.get('CDF_PROJECT', 'my-project'),\n    api_key=os.environ.get('CDF_API_KEY', '')\n)\nprint(client.status())","lang":"python","description":"Initialize a ToolkitClient and check the connection status."},"warnings":[{"fix":"Use `from cognite_toolkit import ToolkitClient` instead of `import cognite_toolkit`.","message":"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.","severity":"breaking","affected_versions":">=0.7.0"},{"fix":"Replace `default_env` with `default_config_yaml` in your `cdf.toml`.","message":"The argument `default_env` in `cdf.toml` is deprecated; use `default_config_yaml` instead.","severity":"deprecated","affected_versions":">=0.8.61"},{"fix":"Set `CDF_CLIENT_ID` and `CDF_CLIENT_SECRET` environment variables instead of passing them as flags.","message":"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`.","severity":"gotcha","affected_versions":"all"},{"fix":"Validate your YAML files against the expected schema before deployment.","message":"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.","severity":"gotcha","affected_versions":">=0.8.58"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Install via `pip install cognite-toolkit` and import as `from cognite_toolkit import ToolkitClient`.","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'.","error":"ModuleNotFoundError: No module named 'cognite_toolkit'"},{"fix":"Use `from cognite_toolkit import ToolkitClient`.","cause":"Using `import cognite_toolkit` and then accessing `cognite_toolkit.ToolkitClient`. The correct import is `from cognite_toolkit import ToolkitClient`.","error":"AttributeError: module 'cognite_toolkit' has no attribute 'ToolkitClient'"},{"fix":"Rename `default_env` to `default_config_yaml` in your `cdf.toml`.","cause":"Using the deprecated `default_env` field in `cdf.toml` instead of `default_config_yaml`.","error":"cognite_toolkit.exceptions.CogniteToolkitError: Invalid configuration: 'default_env' is not a valid field","affected_versions":">=0.8.61"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}