[!NOTE] sort-tui is built entirely on standard libraries (curses), meaning zero dependencies and instant execution on any POSIX system.

✨ Features

📦 Installation

Install sort-tui directly from PyPI. A Python 3.10+ environment is required.

pip install sort-tui

[!TIP] For Windows users, curses is not natively supported by cmd. We recommend running sort-tui inside WSL, or manually installing windows-curses (pip install windows-curses).

🚀 Quick Start

Launch an interactive visualization immediately:

# Visualize a standard Bubble Sort
sort-tui --algorithm bubble

# Test TimSort on a nearly sorted array of 100 elements
sort-tui --algorithm timsort --distribution nearly_sorted --size 100

# Compare Quicksort, Merge Sort, and Heapsort side-by-side
sort-tui --compare quicksort merge heapsort

# Run a headless benchmark suite
sort-tui --benchmark bubble insertion quicksort --size 500

⌨️ Interactive Hotkeys

sort-tui is fully interactive during playback.

📚 Documentation

Dive deeper into the inner workings, advanced configuration, and data science metrics of sort-tui:

• Algorithm Contract & Architecture
• Performance Benchmarks
• Advanced Features (Replay, Audio, Fingerprinting)
• Configuration & Profiles
• Plugin Guide (Write your own sorts!)

🏗 Tech Stack

🤝 Contributing & Community

We welcome contributions of all sizes! Whether it's adding a new esoteric sorting algorithm, fixing a bug, or improving the visuals.

• Please read our Contributing Guidelines to get started.
• Check out the Roadmap to see where the project is heading.
• Review our Code of Conduct.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.