keboola.component

What it is and what it does

Keboola Component is a Python library that abstracts the Keboola Common Interface specification, reducing boilerplate when building Docker components for the Keboola Connection platform. It provides a CommonInterface class that initializes the component environment, loads configuration from config.json, processes input and output tables via manifest files and I/O mapping, handles state files, and manages logging. The library also includes base classes for building component applications and data classes for Common Interface objects like manifests and metadata.

The package is intended for developers building Keboola components in Python and for use within Keboola Python Transformations. It depends on pygelf, deprecated, and keboola.vcr. The library requires Python 3.10 or later and is officially supported by Keboola.

Use it for:

• Build a Docker component for Keboola Connection that reads input tables, applies transformations, and writes output tables using I/O mapping.
• Simplify configuration and state management in a Python transformation script running inside Keboola.
• Create a component that processes input files, groups them by tags, and generates output files with minimal boilerplate.
• Implement logging in a Keboola component that automatically routes based on environment setup.
• Develop a component with sync actions that return structured data or validation messages to the Keboola platform.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Wraps the Keboola Common Interface to simplify Docker component development, handling configuration loading, I/O mapping, manifest processing, and logging within the Keboola Connection environment.

Yes. The package is actively maintained, carries no known vulnerabilities, uses a permissive MIT license, and has low install friction. Install it if you are building Keboola components or transformations in Python and want to avoid writing Common Interface boilerplate. Not relevant if you are not working within the Keboola ecosystem.

Install

keboola-component on PyPI

pip install keboola-component

uv add keboola-component

poetry add keboola-component

Installing keboola.component

Before you install

Low install friction with a pure Python wheel distribution. Actively maintained with a release 45 days ago and recent commits; supports current Python versions.

License in practice

MIT license permits commercial and private use with minimal restrictions; suitable for most projects.

Quickstart

from keboola.component import CommonInterface

ci = CommonInterface()
cfg = ci.configuration

Requires Python 3.10 or later; typically run within Keboola Docker environment with KBC_DATADIR set or data folder present.

Verify before relying

• Whether pygelf, deprecated, and keboola.vcr are well-maintained and carry no known vulnerabilities.
• Whether the package works reliably outside Keboola's Docker environment or if it requires specific folder/environment setup.

Package facts

Evidence: keboola_component-1.11.0-py3-none-any.whl

Tags

More Libraries packages