Crate jupyter

Easy Jupyter Client for your Language

use clap::Parser;
use clap_derive::{Parser, Subcommand};
use jupyter::{InstallAction, JupyterResult, OpenAction, StartAction, UninstallAction};
use std::path::PathBuf;

#[derive(Parser)]
#[command(author, version, about, long_about = None)]
pub struct JupyterApplication {
    /// Sets a custom config file
    #[arg(short, long, value_name = "FILE")]
    config: Option<PathBuf>,
    /// Turn debugging information on
    #[arg(short, long, action = clap::ArgAction::Count)]
    debug: u8,
    #[command(subcommand)]
    command: JupyterCommands,
}

#[derive(Subcommand)]
enum JupyterCommands {
    Open(Box<OpenAction>),
    Start(Box<StartAction>),
    Install(Box<InstallAction>),
    Uninstall(Box<UninstallAction>),
}

impl JupyterApplication {
    pub fn run(&self) -> JupyterResult<()> {
        match &self.command {
            JupyterCommands::Open(v) => v.run(),
            JupyterCommands::Start(v) => v.run(),
            JupyterCommands::Install(v) => v.run(),
            JupyterCommands::Uninstall(v) => v.run(),
        }
    }
}

fn main() -> JupyterResult<()> {
    let app = JupyterApplication::parse();
    app.run()
}

Modules

• value_type
  Some helpful value types for Jupyter Kernel Protocol.

Structs

• ExecutionReply
  The request to execute code
• ExecutionRequest
  The request to execute code
• ExecutionResult
  The result of executing code
• InstallAction
  To install/overwrite a new kernel to jupyter.
• JupyterConnection
  Indicates successful establishment of link with jupyter frontend
• JupyterError
  The error type for Jupyter.
• JupyterKernelSockets
  The sockets for Jupyter kernel.
• JupyterMessage
  Represent a message from jupyter client
• JupyterStream
  Represents a stream via standard output
• LanguageInfo
  The language information and abilities provided by the kernel
• OpenAction
  Open the jupyter-lab application for debug.
• StartAction
  To start a jupyter kernel for language.
• UnboundedSender
  Send values to the associated UnboundedReceiver.
• UninstallAction
  Uninstall the jupyter kernel of language.

Enums

• ExecutionPayloadDeprecated
  The result of executing code
• JupyterErrorKind
  The error kind for Jupyter.
• Value
  Represents any valid JSON value.

Traits

• Executed
  A executed result that can be render in jupyter notebook.
• JupyterKernelProtocol
  The protocol of the kernel
• Serialize
  A data structure that can be serialized into any data format supported by Serde.

Functions

• to_value
  Convert a T into serde_json::Value which is an enum that can represent any valid JSON data.

Type Aliases

• JupyterResult
  The result type for Jupyter.

Derive Macros

• Serialize