Metadata-Version: 2.4
Name: tui_writer
Version: 0.1.0
Summary: A TUI that you run to transcribe and edit text. It's like a companion that dictates for you, engaging in a dialogue to collaboratively update a block of text rather than performing a direct transcription.
Home-page: https://github.com/Swiftner/tui_writer
Author: Mario Michelli
Author-email: mmichelli@gmail.com
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: textual>=6.1.0
Requires-Dist: textual-dev>=1.7.0
Requires-Dist: click
Requires-Dist: sounddevice
Requires-Dist: torch<3.0,>=2.9
Requires-Dist: torchaudio<3.0,>=2.9
Requires-Dist: faster_whisper
Requires-Dist: rich
Requires-Dist: pyperclip
Requires-Dist: pyaudio
Requires-Dist: numpy
Requires-Dist: lisette
Requires-Dist: typer>=0.19.2
Requires-Dist: smolagents[openai]
Requires-Dist: fastrtc>=0.0.33
Requires-Dist: litellm
Dynamic: author
Dynamic: author-email
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# Getting Started


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

## What is TUI Writer?

TUI Writer is a terminal-based application that combines real-time
speech transcription with AI-powered editing. Unlike traditional
transcription tools that simply convert speech to text, TUI Writer acts
as an intelligent companion that understands natural language editing
commands.

**Core Workflow:** <br> 1. Speak into your microphone <br> 2. See your
words transcribed in real-time <br> 3. Make edits by speaking naturally:
“change that to…” or “delete the last sentence” <br> 4. The AI
automatically detects and applies your edits <br> 5. Copy the final
transcript to your clipboard <br>

For developers new to `nbdev`, the following sections explain the
development workflow.

### Install TUI Writer in Development Mode

For development and contributions, install the package in editable mode:

``` sh
# Clone the repository
git clone https://github.com/Swiftner/tui_writer.git
cd tui_writer

# Install in development mode
pip install -e .

# Make changes under nbs/ directory
# The notebooks in nbs/ are the source of truth

# After making changes, regenerate the Python modules
nbdev_prepare
```

The `nbdev_prepare` command: - Exports code from notebooks to Python
modules - Runs tests - Updates documentation - Cleans notebook outputs

## Usage

### Installation

### Installation Options

Install TUI Writer from Github:

``` sh
pip install git+https://github.com/Swiftner/tui_writer.git
```

Or from conda:

``` sh
conda install -c Swiftner tui_writer
```

Or from PyPI:

``` sh
pip install tui_writer
```

### Prerequisites

TUI Writer requires: <br> - Python 3.9 or higher <br> - A working
microphone <br> - API key for at least one LLM provider (OpenAI,
Anthropic, or Google) <br>

### First Run Setup

After installation, launch the application:

``` sh
tui_writer
```

On first run, you will need to: <br> 1. Press `a` to open AI settings
<br> 2. Select your preferred provider (OpenAI, Anthropic, or Google)
<br> 3. Choose a model <br> 4. Enter your API key <br> 5. Press Apply
<br>

The configuration is saved to `~/.config/tui_writer/tui_writer.conf` and
persists across sessions.

### Basic Usage

Once configured: <br> - **Press SPACE** to start recording <br> -
**Speak naturally** - your words appear in real-time <br> - **Say edit
commands** like “change that to…” and they are applied automatically
<br> - **Press SPACE** to stop recording <br> - **Press C** to copy the
transcript to clipboard <br> - **Press Q** to quit <br>

For detailed documentation on all features, press `?` in the application
to view the help screen.
