prompt-toolkit/python-prompt-toolkit
Python Prompt Toolkit
This project is a Python terminal user interface library and toolkit designed for building interactive command-line applications. It provides a terminal input manager and a widget toolkit for rendering dashboards, menus, and editors within a terminal emulator.
The library enables the creation of full-screen terminal interfaces and interactive shells. It distinguishes itself with advanced input handling, including lexer-based syntax highlighting for visual feedback on code structure and support for industry-standard keyboard navigation modes such as Emacs and Vi.
The capability surface covers comprehensive input handling and user interface design. This includes multi-line editing, predictive ghost-text suggestions, auto-completion, and mouse-driven cursor control. It also provides tools for incremental input search and buffer management to track multiple input states.
Features
- Interactive CLI Frameworks - Provides a comprehensive framework for building interactive terminal user interfaces with advanced input and layout management.
- Advanced Prompt Inputs - Implements sophisticated text entry with syntax highlighting, auto-completion, and multi-line editing.
- Custom Completion Providers - Provides a framework for defining custom dynamic command completion logic to accelerate user data entry.
- Terminal Input Handlers - Manages raw keyboard and mouse events, cursor positioning, and autocomplete suggestions within the terminal.
- Terminal Widget Toolkits - Provides a toolkit of reusable interface components like selection menus for keyboard-navigable terminal applications.
- Event-Driven Input Handlers - Implements an asynchronous event loop to process raw terminal keystrokes and mouse events.
- Text Buffer Management - Maintains independent text buffers to track input state separately from the terminal display logic.
- Python TUI Libraries - Acts as a specialized library for building interactive command line applications with dynamic display updates in Python.
- Syntax Highlighters - Provides lexer-based syntax highlighting to apply visual styles based on the grammatical structure of input text.
- Syntax Highlighting - Uses lexers to provide real-time color-coded syntax highlighting for input text.
- Terminal User Interfaces - Enables the creation of complex text-based dashboards and editors that occupy the entire terminal screen.
- Full Screen TUI Layouts - Provides the capability to render complex terminal user interfaces that occupy the entire screen.
- Layered Rendering Engines - Draws UI elements in overlapping tiers to manage complex layouts and full-screen terminal interfaces.
- Incremental Search - Implements reverse and forward incremental search for navigating text patterns within the input buffer.
- Incremental Searchers - Provides real-time character-by-character incremental search and navigation within the input buffer.
- Custom Key Mappings - Implements custom keyboard shortcuts, including Emacs and Vi modes, for efficient text navigation.
- Interactive Shells - Enables the development of interactive shells with read-eval-print loops for executing commands.
- Multi-line Editing - Supports the composition and modification of text spanning multiple lines within interactive shells.
- Modal Key Bindings - Maps keyboard shortcuts to specific actions using interchangeable modes like Emacs or Vi.
- Input State Buffers - Provides independent text buffers to track input state separately from the terminal display logic.
- Terminal Cursor Controllers - Enables mouse-driven cursor positioning and navigation using terminal escape sequences.
- Keyboard Navigation - Integrates industry-standard keyboard shortcuts such as Emacs and Vi modes to improve editing efficiency.
- Terminal Interface Design - Provides patterns and tools for designing structured, accessible user interfaces for command-line tools.
- Predictive Text Inputs - Displays predictive ghost-text completions based on history or rules to anticipate user intent.
- CLI Development - Enables building powerful interactive command-line applications.
- Command Line Interface - Library for building interactive CLI applications.
- Command Line Interfaces - Library for building interactive Python CLI applications.
- Console Interfaces - Listed in the “Console Interfaces” section of the Awesome Go awesome list.
- Python CLI Frameworks - Library for building powerful interactive CLI applications.
- TUI Libraries - Interactive CLI library for Python.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
