PyTEdit

A lightweight, fast, terminal-based text editor library for Python. PyTEdit provides a modular and extensible framework for building terminal text editors, similar to nano or micro, but with modern Python features.

Features

• File loading and saving
• Arrow key navigation
• Basic editing (insert, delete, backspace)
• Save & quit shortcuts (Ctrl+S, Ctrl+Q)
• Responsive interface with smooth cursor movement
• Clean, modular code structure
• Can be used as a library or standalone application

Installation

pip install pytedit

Quick Start

Using as a standalone editor

# Launch editor
pytedit

# Open a file
pytedit myfile.txt

Using as a library in your project

from pytedit import Editor, TextBuffer

# Create a custom editor
class MyCustomEditor(Editor):
    def __init__(self):
        super().__init__()
        # Add custom initialization
        self.status_message = "My Custom Editor"
    
    def create_key_bindings(self):
        kb = super().create_key_bindings()
        
        # Add custom key bindings
        @kb.add('c-f')
        def _(event):
            self.status_message = "Find functionality (custom)"
            self.refresh_screen()
            
        return kb

# Run your custom editor
if __name__ == "__main__":
    editor = MyCustomEditor()
    editor.run()

Architecture

PyTEdit is built around these core components:

1. TextBuffer: Manages text content and cursor position
2. Editor: Handles input, rendering, and coordinates components
3. Key Bindings: Configurable keyboard shortcuts for editor functions

Development Roadmap

• Undo/redo stack
• Syntax highlighting with Pygments
• Line numbers
• Search & replace functionality
• Configurable themes and keybindings
• Multiple file buffers
• Split-screen editing

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

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