cognite-kuiper 0.18.1__cp313-cp313-macosx_11_0_arm64.whl

cognite_kuiper-0.18.1.dist-info/METADATA

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: cognite-kuiper
+Version: 0.18.1
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python
+Requires-Dist: pytest ; extra == 'test'
+Provides-Extra: test
+Summary: A JSON to JSON transform and templating language from Cognite
+Keywords: JSON,transformation
+Author-email: Mathias Lohne <mathias.lohne@cognite.com>
+Maintainer-email: Mathias Lohne <mathias.lohne@cognite.com>
+License: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: homepage, https://cognite.com
+Project-URL: repository, https://github.com/cognitedata/kuiper
+
+# Python bindings for Kuiper
+
+Python bindings for Kuiper so you can compile and run transformations from a
+Python runtime.
+
+``` python
+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.
+
+## Development
+
+We use [PyO3](https://pyo3.rs) to create the bindings.
+
+This project uses [maturin](https://www.maturin.rs/) to manage dependencies and
+such, instead of poetry. To set up your local development environment, first
+make sure maturin is installed:
+
+``` commanline
+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:
+
+``` commandline
+source enter.sh
+```
+
+``` commandline
+source exit.sh
+```
+
+Whenever you change the code, you need to rebuild. Instead of using `cargo`
+directly, use `maturin`:
+
+``` commandline
+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.
+

cognite_kuiper-0.18.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+cognite_kuiper-0.18.1.dist-info/METADATA,sha256=FWHKABGXiBXqlLn_yDFMr2f_7ihbZM52e9VKR6kg194,2075
+cognite_kuiper-0.18.1.dist-info/WHEEL,sha256=V0PyzvBcSARU334gfbMpVsvFu6xR7hFdhQVohqdzf7E,105
+kuiper/__init__.py,sha256=AAn8YXHCMW4EL5okpVW71cwmTYg608hpp7FJDUnafo0,611
+kuiper/kuiper.cpython-313-darwin.so,sha256=XumFgQH_jCkYTqKbsH4NEamQghYqcznNdJaL0S69D7c,3782480
+kuiper/kuiper.pyi,sha256=RW6RQDiC8LnaHs5DDRg-bUYIhuUm8O0Q-fZyW4nGz_4,453
+kuiper/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cognite_kuiper-0.18.1.dist-info/RECORD,,

cognite_kuiper-0.18.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.11.5)
+Root-Is-Purelib: false
+Tag: cp313-cp313-macosx_11_0_arm64

kuiper/__init__.py

@@ -0,0 +1,17 @@
+"""
+Kuiper is a JSON to JSON transform and templating language from Cognite.
+
+.. code-block:: python
+
+    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.
+"""
+
+from .kuiper import *

kuiper/kuiper.pyi

@@ -0,0 +1,15 @@
+class KuiperError(BaseException):
+    start: int | None
+    end: int | None
+    ...
+
+class KuiperCompileError(KuiperError): ...
+class KuiperRuntimeError(KuiperError): ...
+
+class KuiperExpression:
+    def run(self, input: str) -> str: ...
+    def run_multiple_inputs(self, inputs: list[str]) -> str: ...
+
+def compile_expression(
+    expression: str, inputs: list[str], optimizer_operation_limit=100000, max_macro_expansions=20
+) -> KuiperExpression: ...