cognite-kuiper 0.18.2

A JSON to JSON transform and templating language from Cognite

Python bindings for Kuiper

Python bindings for Kuiper so you can compile and run transformations from a Python runtime.

The language itself is documented here.

from kuiper import compile_expression

expression = compile_expression('{"theAnswer": input.numericValue + 27}', ["input"])
value = expression.run('{"numericValue": 15}')
print(value)

The compile_expression function might raise a KuiperCompileError, and otherwise returns a KuiperExpression object. The KuiperExpression.run(...) method might raise a KuiperRuntimeError. Both of these exceptions are subclasses of the KuiperError base class.

The packakge is available on PyPI. To use it in your project, add it to your project file with your project manager of choice. For example, using uv:

uv add cognite-kuiper

Development

We use PyO3 to create the bindings.

This project uses maturin to manage dependencies and such. To set up your local development environment, first make sure maturin is installed:

pip install -U maturin

Then, you can enter or exit a virtual environment with the kuiper package installed by sourcing the enter.sh or exit.sh scripts:

source enter.sh

source exit.sh

Whenever you change the code, you need to rebuild. Instead of using cargo directly, use maturin:

maturin develop

This will build and install the python package into the current environment, which is the virtual environment created by the enter.sh script.