ted-editor 0.1.4

A simple cross-platform TUI editor with a CLI and API using Textual

Installation

# without syntax highlight
pip install ted-editor

# with syntax highlight
pip install ted-editor[syntax]

Key Features

1. Dual Interface:

   • CLI: ted <filepath>
   • API: ted.edit(content, filepath)

2. File Handling:

   • Prompt for file path if not provided
   • Ask for file creation if doesn't exist
   • Handle permission errors

3. TUI Editor:

   • Textual-based interface
   • Save with Ctrl+S or Save button
   • Quit with Ctrl+Q or Quit button
   • Shows modification status in title
   • Auto-save on quit if modified

4. API Behavior:

   • content=None: Load from file if exists
   • filepath=None: Memory-only editing
   • Returns edited content

5. Cross Platform:

   • Available in Windows, macOS, Linux

Usage

CLI:

ted  # Prompts for file path
ted myfile.txt

API:

from ted import edit

# Edit existing file
content = edit(filepath="existing.txt")

# Create new file
new_content = edit(content="New content", filepath="new.txt")

# Memory-only editing
temp_content = edit(content="Temporary text")

Screenshots

See also

edit (Microsoft rewrite in Rust)

textual-editor (Most similar, with a directory tree tab)

TED (MS-DOS)

ted (Go implementation)