#jupyter #websocket-client #server #reader #kernel #launch

jupyter-websocket-client

Connect to Jupyter Servers over WebSockets

11 releases (breaking)

new 0.9.0 Jan 9, 2025
0.8.0 Dec 2, 2024
0.7.0 Dec 2, 2024
0.6.0 Nov 28, 2024

#65 in WebSocket

Download history 85/week @ 2024-10-22 279/week @ 2024-10-29 20/week @ 2024-11-05 232/week @ 2024-11-12 2885/week @ 2024-11-19 2589/week @ 2024-11-26 2968/week @ 2024-12-03 2428/week @ 2024-12-10 1967/week @ 2024-12-17 1290/week @ 2024-12-24 2070/week @ 2024-12-31 2872/week @ 2025-01-07

8,570 downloads per month

BSD-3-Clause

135KB
2.5K SLoC

jupyter-websocket-client crate

Note: This crate does not support tokio at this time.

Usage

use jupyter_websocket_client::RemoteServer;

use jupyter_protocol::{KernelInfoRequest, JupyterMessageContent};

// Import the sink and stream extensions to allow splitting the socket into a writer and reader pair
use futures::{SinkExt as _, StreamExt as _};

pub async fn connect_kernel() -> anyhow::Result<()> {
    let server = RemoteServer::from_url(
        "http://127.0.0.1:8888/lab?token=f487535a46268da4a0752c0e162c873b721e33a9e6ec8390"
    )?;

    // You'll need to launch a kernel and get a kernel ID using your own HTTP
    // request library
    let kernel_id = "1057-1057-1057-1057";

    let kernel_socket = server.connect_to_kernel(kernel_id).await?;

    let (mut w, mut r) = kernel_socket.split();

    w.send(KernelInfoRequest {}.into()).await?;

    while let Some(response) = r.next().await.transpose()? {
        match response.content {
            JupyterMessageContent::KernelInfoReply(kernel_info_reply) => {
                println!("Received kernel_info_reply");
                println!("{:?}", kernel_info_reply);
                break;
            }
            other => {
                println!("Received");
                println!("{:?}", other);
            }
        }
    }

    Ok(())
}

Dependencies

~18–29MB
~539K SLoC