Metadata-Version: 2.4
Name: proofd
Version: 0.1.1
Summary: TUI proofreader powered by Claude
Project-URL: Repository, https://github.com/luiul/proofd
Project-URL: Issues, https://github.com/luiul/proofd/issues
License-Expression: MIT
License-File: LICENSE
Keywords: claude,cli,grammar,proofreader,spelling,textual,tui
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: anthropic[bedrock]>=0.50
Requires-Dist: textual>=3.0
Description-Content-Type: text/markdown

# proofd

A terminal UI proofreader powered by Claude. Paste your text, pick an audience and model, and get back three tone variants (concise, polished, verbose) with corrected spelling, grammar, and technical terminology. The polished variant is auto-copied to your clipboard.

Built for data/analytics engineers -- it understands terms like ETL, dbt, medallion architecture, and more.

## Installation

Requires [uv](https://docs.astral.sh/uv/) and an Anthropic API key (`ANTHROPIC_API_KEY`) or AWS credentials configured for Bedrock.

```bash
uv tool install git+https://github.com/luiul/proofd.git
```

Then run it from anywhere:

```bash
proofd
```

## Development

```bash
git clone https://github.com/luiul/proofd.git
cd proofd
uv sync
uv run proofd
```

To test local changes as an installed tool:

```bash
uv tool install --reinstall .
```

## Controls

| Key / Action          | Description                                  |
| --------------------- | -------------------------------------------- |
| `Ctrl+Enter`          | Run proofread                                |
| `Ctrl+L`              | Clear input and results                      |
| `Ctrl+Q`              | Quit                                         |
| Audience selector     | team, leadership, cross-functional, external |
| Model selector        | haiku, sonnet, opus                          |
| Special instructions  | Optional free-text field for extra guidance   |
| Copy button           | Copies that variant to clipboard             |

## Environment variables

| Variable | Description |
| -------- | ----------- |
| `ANTHROPIC_API_KEY` | API key for direct Anthropic access |
| `AWS_PROFILE` | AWS profile for Bedrock access |
| `AWS_REGION` / `AWS_DEFAULT_REGION` | AWS region for Bedrock |
| `ANTHROPIC_DEFAULT_HAIKU_MODEL` | Override the default Haiku model ID |
| `ANTHROPIC_DEFAULT_SONNET_MODEL` | Override the default Sonnet model ID |
| `ANTHROPIC_DEFAULT_OPUS_MODEL` | Override the default Opus model ID |
