# saulpw/visidata architecture

> Architecture diagram of the GitHub repository saulpw/visidata, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/saulpw/visidata
- Repository: https://github.com/saulpw/visidata

## Overview

##### Main Components Architecture

a) Core Engine Layer:
- Base Components (/visidata/)
- Sheet Management (basesheet.py, sheets.py)
- Command Processing (cmdlog.py)
- Data Types (_types.py)
- Expression Engine (expr.py)

b) Interface Layer:
- Terminal UI Components
- Management (interface.py)
- Input Handling (_input.py)
- Status Bar (statusbar.py)
- Mouse Support (mouse.py)

c) Data Processing Layer:
- Loaders (/visidata/loaders/)
- File Format Handlers (csv.py, json.py, xlsx.py, etc.)
- Database Connectors (sqlite.py, postgres.py)
- Network Loaders (http.py)
- Data Manipulation
- Aggregators (aggregators.py)
- Sorting (sort.py)
- Filtering (selection.py)

d) Extension System:
- Plugin Architecture (plugins.py)
- Features Management (/visidata/features/)
- Experimental Features (/visidata/experimental/)

##### Data Flow Representation

**[Input Sources] → [Loaders] → [Core Engine] → [Interface Layer] → [Display]**
- ↕            ↕               ↕
- [Plugin System] [Data Processing] [User Input]

##### Component Relationships

- Data flow between components
- Command processing flow
- Plugin integration points
- Extension hooks

##### Key Design Elements to Highlight

a) Modular Architecture:
- Clear separation between core, interface, and data processing
- Plugin system integration points

b) Data Processing Pipeline:
- Input handling
- Data transformation
- Rendering

c) Extension Points:
- Plugin hooks
- Custom loader integration
- Feature addition mechanisms

##### Implementation Details

Technical details like:
- Python version requirements (3.8+)
- External dependencies
- File format support
- Platform compatibility

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef core fill:#a8d1f0,stroke:#333
    classDef interface fill:#ffe599,stroke:#333
    classDef data fill:#b6d7a8,stroke:#333
    classDef extension fill:#d5a6bd,stroke:#333
    classDef external fill:#gray,stroke:#333

    %% Core Engine Layer
    subgraph CoreEngine["Core Engine Layer"]
        Base["Base Components"]:::core
        SheetMgmt["Sheet Management"]:::core
        CmdProc["Command Processing"]:::core
        DataTypes["Data Types"]:::core
        ExprEngine["Expression Engine"]:::core
        Settings["Settings Management"]:::core
        Utils["Utils & Helpers"]:::core
        Main["Main Application"]:::core
    end

    %% Interface Layer
    subgraph Interface["Interface Layer"]
        TermUI["Terminal UI"]:::interface
        InputHandler["Input Handling"]:::interface
        ColorMgmt["Color Management"]:::interface
        StatusBar["Status Bar"]:::interface
        MouseSupport["Mouse Support"]:::interface
    end

    %% Data Processing Layer
    subgraph DataProc["Data Processing Layer"]
        Loaders["Loaders"]:::data
        DataManip["Data Manipulation"]:::data
        Aggregators["Aggregators"]:::data
        Sorting["Sorting"]:::data
        Filtering["Filtering"]:::data
        ColMgmt["Column Management"]:::data
    end

    %% Extension System
    subgraph Extensions["Extension System"]
        PluginArch["Plugin Architecture"]:::extension
        FeaturesMgmt["Features Management"]:::extension
        ExpFeatures["Experimental Features"]:::extension
    end

    %% Relationships
    Base --> SheetMgmt
    Base --> CmdProc
    Base --> DataTypes
    Main --> Base
    Settings --> Base
    Utils --> Base

    TermUI --> Base
    InputHandler --> TermUI
    ColorMgmt --> TermUI
    StatusBar --> TermUI
    MouseSupport --> TermUI

    Loaders --> Base
    DataManip --> Base
    Aggregators --> DataManip
    Sorting --> DataManip
    Filtering --> DataManip
    ColMgmt --> DataManip

    PluginArch --> Base
    FeaturesMgmt --> PluginArch
    ExpFeatures --> PluginArch

    %% Click Events
    click Base "https://github.com/saulpw/visidata/blob/develop/visidata/basesheet.py"
    click SheetMgmt "https://github.com/saulpw/visidata/blob/develop/visidata/sheets.py"
    click CmdProc "https://github.com/saulpw/visidata/blob/develop/visidata/cmdlog.py"
    click DataTypes "https://github.com/saulpw/visidata/blob/develop/visidata/_types.py"
    click ExprEngine "https://github.com/saulpw/visidata/blob/develop/visidata/expr.py"
    click Settings "https://github.com/saulpw/visidata/blob/develop/visidata/settings.py"
    click Utils "https://github.com/saulpw/visidata/blob/develop/visidata/utils.py"
    click Main "https://github.com/saulpw/visidata/blob/develop/visidata/main.py"
    click TermUI "https://github.com/saulpw/visidata/blob/develop/visidata/interface.py"
    click InputHandler "https://github.com/saulpw/visidata/blob/develop/visidata/_input.py"
    click ColorMgmt "https://github.com/saulpw/visidata/blob/develop/visidata/color.py"
    click StatusBar "https://github.com/saulpw/visidata/blob/develop/visidata/statusbar.py"
    click MouseSupport "https://github.com/saulpw/visidata/blob/develop/visidata/mouse.py"
    click Loaders "https://github.com/saulpw/visidata/tree/develop/visidata/loaders/"
    click DataManip "https://github.com/saulpw/visidata/blob/develop/visidata/modify.py"
    click Aggregators "https://github.com/saulpw/visidata/blob/develop/visidata/aggregators.py"
    click Sorting "https://github.com/saulpw/visidata/blob/develop/visidata/sort.py"
    click Filtering "https://github.com/saulpw/visidata/blob/develop/visidata/selection.py"
    click ColMgmt "https://github.com/saulpw/visidata/blob/develop/visidata/column.py"
    click PluginArch "https://github.com/saulpw/visidata/blob/develop/visidata/plugins.py"
    click FeaturesMgmt "https://github.com/saulpw/visidata/tree/develop/visidata/features/"
    click ExpFeatures "https://github.com/saulpw/visidata/tree/develop/visidata/experimental/"

    %% Legend
    subgraph Legend
        CoreComp["Core Component"]:::core
        InterfaceComp["Interface Component"]:::interface
        DataComp["Data Processing Component"]:::data
        ExtensionComp["Extension Component"]:::extension
    end
```
