Skip to main content

Jupyter kernel for Kiwi.

Project description

Kiwi Jupyter Kernel

kiwi-array-jupyter is a Jupyter kernel for Kiwi that takes the direct-bridge route:

  • Jupyter runs a small Python ipykernel host
  • the Python host loads the local Kiwi C ABI bridge with ctypes
  • the bridge owns a persistent Kiwi Session
  • the bridge and Session come from the Kiwi source checkout or the packaged wheel payload

This deliberately avoids the JSON REPL transport. The kernel boundary is:

Jupyter
  -> ipykernel
  -> ctypes
  -> libkiwi_bridge
  -> Kiwi Session
  -> MLX

What Is Here

Current Scope

This first cut is intentionally narrow:

  • execution is direct and stateful
  • cells run line-by-line using the same blank-line and full-line-comment rules as script mode
  • assignments suppress output
  • echoed results surface in the notebook
  • JSON strings that carry a Vega-Lite schema also surface as Vega-Lite MIME data
  • completion and inspect cover the current built-in named functions
  • delimiter-only is_complete distinguishes incomplete from clearly invalid input

It does not yet try to provide:

  • general structured array display beyond text/plain
  • parser-aware completeness checks
  • full symbol completion from live session state
  • a native Zig Jupyter wire-protocol implementation

Build And Install

From the Kiwi repository root:

cd extensions/jupyter-kiwi
uv python install --managed-python 3.14.2
uv sync --managed-python --python 3.14.2 --group dev
uv run --managed-python python -m kiwi_array_jupyter_kernel.install --user

In a fresh public checkout, bootstrap MLX first from the Kiwi root with KIWI_MLX_BACKEND=cpu scripts/bootstrap_deps.sh unless .deps/mlx and .deps/mlx-c already exist.

The install helper builds the official bridge in ../../implementations/kiwi-zig-main/zig-out/lib if needed. The installed library is:

  • ../../implementations/kiwi-zig-main/zig-out/lib/libkiwi_bridge.dylib on macOS
  • ../../implementations/kiwi-zig-main/zig-out/lib/libkiwi_bridge.so on Linux

The install helper writes a kernelspec that launches:

python -m kiwi_array_jupyter_kernel -f {connection_file}

When the bridge has already been built, the kernelspec also captures the absolute KIWI_BRIDGE_LIB path so notebook startup does not depend on accidentally finding the right local library at runtime.

Tests

From this directory:

uv run --managed-python pytest tests/test_kiwi_jupyter_kernel.py
zig build test

From the repository root, make test-jupyter runs the Python Jupyter kernel tests when that target is available.

Notes

  • The pinned dev interpreter is the uv-managed CPython 3.14.2 patch release tracked in .python-version.
  • The dev dependency group includes the Python test stack for the kernel host plus jupyter_kernel_test for end-to-end kernel validation work.
  • The kernelspec logo is sourced from the vendored src/kiwi_array_jupyter_kernel/assets/kernel-logo.png, derived from the current website favicon artwork instead of depending on generated website output.
  • The loader looks for packaged wheel libraries first and then ../../implementations/kiwi-zig-main/zig-out/lib in source checkouts.
  • Set KIWI_BRIDGE_LIB to override the bridge path.
  • KIWI_JUPYTER_BRIDGE_LIB is still accepted as a compatibility alias.
  • Set KIWI_MLX_PREFIX and KIWI_MLX_C_INCLUDE to override the MLX link inputs when building the bridge from Python.
  • Set KIWI_JUPYTER_DEVICE=cpu or gpu to pin the default MLX device.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kiwi_array_jupyter-0.2.49-py3-none-any.whl (47.7 kB view details)

Uploaded Python 3

File details

Details for the file kiwi_array_jupyter-0.2.49-py3-none-any.whl.

File metadata

File hashes

Hashes for kiwi_array_jupyter-0.2.49-py3-none-any.whl
Algorithm Hash digest
SHA256 322902a6ab7fa303a724e2a8c1fc7c36936a761864cfe1c57857826d19085aee
MD5 e91e1ac032a1a90608ff1802c0d3b20a
BLAKE2b-256 be9b73f5b11f9191a9df1cb758714a136340f06c301f4f7fc713e0e16663dfd4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page