#jupyter #remote-server #token

jupyter-websocket-client

Connect to Jupyter Servers over WebSockets

11 releases (breaking)

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

#125 in WebSocket

Download history 1851/week @ 2024-12-29 3268/week @ 2025-01-05 2840/week @ 2025-01-12 2151/week @ 2025-01-19 2254/week @ 2025-01-26 2305/week @ 2025-02-02 2527/week @ 2025-02-09 2733/week @ 2025-02-16 2835/week @ 2025-02-23 2936/week @ 2025-03-02 2983/week @ 2025-03-09 2987/week @ 2025-03-16 2968/week @ 2025-03-23 2876/week @ 2025-03-30 1726/week @ 2025-04-06 370/week @ 2025-04-13

8,255 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–31MB
~557K SLoC