API Reference

Subpackages and Modules

vimsheet.app

VimSheet Textual application.

vimsheet.command_completer

Tab-completion engine for command mode.

vimsheet.help_entries

Static help entries — key bindings and commands.

vimsheet.help_registry

Help registry — manages sections, subgroups, and renders help content.

vimsheet.controller

Mode state machine and key event handlers.

vimsheet.controller.edit_handler

Edit mode key handler — vi-style line editing of existing cell content.

vimsheet.controller.insert_handler

Insert mode key handler.

vimsheet.controller.macro

Macro recording and replay for vim-style q{reg}/@{reg} macros.

vimsheet.controller.mode

Mode enum and state-machine transitions.

vimsheet.controller.normal_handler

Normal mode key handler — all vim-like Normal mode bindings.

vimsheet.controller.search

Find-and-replace logic for VimSheet.

vimsheet.controller.visual_handler

Visual mode key handler.

vimsheet.fetch

vimsheet.fetch.fetch_manager

FetchManager — coordinates background HTTP fetches per cell.

vimsheet.fetch.fetch_worker

Low-level HTTP fetch helpers — no Textual or VimSheet model imports.

vimsheet.formula

Formula engine: tokenizer, parser, evaluator, dependency graph.

vimsheet.formula.ast_nodes

AST node dataclasses for the formula parser.

vimsheet.formula.dependency

Dependency DAG for formula recalculation.

vimsheet.formula.evaluator

Formula evaluator — walks the AST and resolves values.

vimsheet.formula.parser

Recursive-descent parser — converts a Token list into an AST.

vimsheet.formula.tokenizer

Formula lexer — converts a formula string into a list of Tokens.

vimsheet.formula.tokens

Token types and Token dataclass for the formula lexer.

vimsheet.formula.functions

Auto-import all function modules to populate the registry.

vimsheet.formula.functions.date_funcs

Date/Time built-in functions.

vimsheet.formula.functions.logic_funcs

Logic built-in functions.

vimsheet.formula.functions.lookup_funcs

Lookup and reference built-in functions.

vimsheet.formula.functions.math_funcs

Math and aggregation built-in functions.

vimsheet.formula.functions.net_funcs

Network formula functions — @FETCH.

vimsheet.formula.functions.registry

Function registry — maps uppercase names to callable implementations.

vimsheet.formula.functions.text_funcs

Text built-in functions.

vimsheet.io

VimSheet I/O adapters package.

vimsheet.io.base

Abstract base class for all format adapters.

vimsheet.io.csv_adapter

CSV / TSV import and export adapter.

vimsheet.io.html_adapter

HTML table export adapter.

vimsheet.io.json_adapter

JSON I/O for VimSheet.

vimsheet.io.latex_adapter

LaTeX tabular export adapter.

vimsheet.io.markdown_adapter

Markdown table export adapter.

vimsheet.io.registry

Adapter registry — maps file extensions and format names to FormatAdapter instances.

vimsheet.io.xls_adapter

Legacy Excel .xls import via xlrd.

vimsheet.io.xlsx_adapter

Excel .xlsx import/export via openpyxl.

vimsheet.model

Data model: Cell, Sheet, Workbook, Range.

vimsheet.model.cell

Cell and CellFormat dataclasses.

vimsheet.model.config

Runtime configuration for VimSheet.

vimsheet.model.range

A1 notation helpers and named-range registry.

vimsheet.model.sheet

Sheet model — a single tab in a workbook.

vimsheet.model.undo

Command-pattern undo/redo stack for VimSheet.

vimsheet.model.validation

Cell data-validation rules.

vimsheet.model.workbook

Workbook model — a collection of sheets with session state.

vimsheet.plotting

VimSheet plotting package.

vimsheet.plotting.chart

Spreadsheet chart rendering — ASCII fallback, plotext when available.

vimsheet.scripting

VimSheet scripting package.

vimsheet.scripting.engine

VimSheet scripting engine — executes a mini-DSL of spreadsheet commands.

vimsheet.ui

Textual UI widgets.

vimsheet.ui.buffers_screen

Buffer list overlay — shown by :buffers / :bufs / :ls.

vimsheet.ui.chart_screen

Chart display overlay for VimSheet.

vimsheet.ui.fetch_list_screen

FetchListScreen — modal listing all active FETCH cells.

vimsheet.ui.formula_bar

Formula bar widget — address, formula/value display, mode indicator.

vimsheet.ui.funcs_screen

Functions reference modal — lists all formula functions with signatures.

vimsheet.ui.grid

GridWidget — virtual-scrolling spreadsheet grid with variable row heights.

vimsheet.ui.help_screen

Full-screen help overlay with tabs, collapsible subgroups, and vim search.

vimsheet.ui.sheet_tabs

Sheet tab strip — rendered inline via Rich Text, scrollable via mouse wheel.

vimsheet.ui.status_bar

Status bar widget — mode, position, stats, file status, clock.

vimsheet.ui.vim_modal

Base class for all VimSheet modal screens with vim-style scroll bindings.