JupyterClient

JupyterClient(connection_info: JupyterConnectionInfo)

(Experimental) A client for communicating with a Jupyter gateway server.

Parameters:
NameDescription
connection_infoConnection information

Type: JupyterConnectionInfo

Class Attributes

get_kernel_client



Instance Methods

delete_kernel

delete_kernel(self, kernel_id: str) -> None
Parameters:
NameDescription
kernel_idType: str

list_kernel_specs

list_kernel_specs(self) -> dict[str, dict[str, str]]

list_kernels

list_kernels(self) -> list[dict[str, str]]

restart_kernel

restart_kernel(self, kernel_id: str) -> None
Parameters:
NameDescription
kernel_idType: str

start_kernel

start_kernel(self, kernel_spec_name: str) -> str

Start a new kernel.

Parameters:
NameDescription
kernel_spec_nameName of the kernel spec to start

Type: str
Returns:
TypeDescription
strstr: ID of the started kernel