venus

Main crate for Venus - a reactive notebook environment for Rust.

Overview

This crate provides:

The core #[venus::cell] macro for defining notebook cells
The Render trait for custom output rendering
Interactive widgets (sliders, text inputs, checkboxes, dropdowns)
CLI binaries (venus and venus-worker) when installed with cargo install venus

Installation

As a CLI tool (recommended for most users):

cargo install venus

This installs both the venus and venus-worker binaries.

As a library (for embedding in other projects):

Add this to your Cargo.toml:

[dependencies]
venus = { version = "x.x", default-features = false }

Example

use venus::prelude::*;

/// A simple cell that returns a number
#[venus::cell]
pub fn number() -> i32 {
    42
}

/// A cell that depends on the previous cell
#[venus::cell]
pub fn doubled(number: &i32) -> i32 {
    number * 2
}

Features

cli (default) - Include CLI binaries and their dependencies
polars - Enable DataFrame rendering support
image - Enable image rendering support
full - Enable all optional features (cli, polars, image)

Documentation

For complete documentation and examples, visit:

License

Licensed under the Apache License, Version 2.0. See LICENSE for details.