High Level API

These functions are convenient interfaces to start and interact with Jupyter kernels.

Async interface

These functions are meant to be called from an asyncio event loop.

class jupyter_kernel_mgmt.run_kernel_async(name, **kwargs)

Context manager to run a kernel by kernel type name.

Gives an async client:

async with run_kernel_blocking("pyimport/kernel") as kc:
    await kc.execute("a = 6 * 7")
async jupyter_kernel_mgmt.start_kernel_async(name, cwd=None, launch_params=None, finder=None)

Start a kernel by kernel type name, return (manager, async client)

Blocking interface

jupyter_kernel_mgmt.run_kernel_blocking(name, **kwargs)

Context manager to run a kernel by kernel type name.

Gives a blocking client:

with run_kernel_blocking("pyimport/kernel") as kc:
    kc.execute_interactive("print(6 * 7)")
jupyter_kernel_mgmt.start_kernel_blocking(name, *, cwd=None, launch_params=None, finder=None, startup_timeout=60)

Start a kernel by kernel type name, return (manager, blocking client)