Keboola Component

raw JSON →
1.10.0 verified Mon Apr 27 auth: no python

General library for building Python applications that run in the Keboola Connection environment. Provides abstractions for configuration parsing, logging, and data I/O. Current version 1.10.0, requires Python >=3.10. Released irregularly.

pip install keboola-component

Common errors

error ModuleNotFoundError: No module named 'keboola_component' ↓
cause Incorrect import path; the correct module name uses a dot: keboola.component.
fix
Run: import keboola.component
error keboola.component.exceptions.UserException: Invalid configuration ↓
cause The configuration JSON is missing required fields like 'parameters' or 'image_parameters'.
fix
Ensure config.json in KBC_DATADIR is valid and includes all expected sections.

Warnings

breaking Version 2.0 may remove deprecated classes like 'Application'. Use CommonInterface instead. ↓
fix Replace 'from keboola.component import Application' with CommonInterface.
deprecated The 'logging' module's `set_default_logger` may be removed; the library now tags own handlers. ↓
fix Use CommonInterface's logging directly or configure custom handlers carefully.
gotcha Environment variables are mandatory: KBC_DATADIR must point to a valid data directory. ↓
fix Set KBC_DATADIR to the directory containing config.json and manifest files.

Imports