Metadata-Version: 2.4
Name: englishup
Version: 0.1.0
Summary: AI-powered grammar checker for the terminal
Keywords: english,grammar,cli,terminal,writing
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Provides-Extra: dev
Requires-Dist: build>=1.2.2; extra == "dev"
Requires-Dist: twine>=6.1.0; extra == "dev"

# EnglishUp

EnglishUp é uma CLI para revisar e melhorar textos em inglês no terminal.

A biblioteca oferece:

- correção gramatical (`check`)
- explicação de erros (`explain`)
- integração com shell (zsh/bash)
- sugestões ao digitar no terminal (live)
- score de qualidade e pontos de melhoria

## Requisitos

- Python `>= 3.9`
- Chave da API da Anthropic

## Instalação

```bash
pip install englishup
```

## Configuração

Você pode configurar a chave da API de duas formas.

### 1) Variável de ambiente (recomendado)

```bash
export ANTHROPIC_API_KEY="sua-chave"
```

### 2) Comando da própria CLI

```bash
englishup config --api-key "sua-chave"
```

Para validar se a chave está configurada:

```bash
englishup config
```

## Uso básico

### Corrigir texto

```bash
englishup check "I have maked a mistake"
```

### Corrigir texto via pipe

```bash
echo "fix the broke pipeline" | englishup check
```

### Explicar erros

```bash
englishup explain "She don't know the answer"
```

## Integração com shell (zsh e bash)

Instala o hook no shell atual (`~/.zshrc` ou `~/.bashrc`):

```bash
englishup setup
```

Depois, recarregue o shell:

```bash
source ~/.zshrc
# ou
source ~/.bashrc
```

Com isso ativo, ao digitar comandos com texto em inglês (ex.: `git commit -m "fix the broke pipeline"`), a CLI pode sugerir melhorias.

Atalhos no modo live (zsh):

- `Tab`: aceita sugestão
- `Esc`: descarta sugestão
- `Enter`: executa o comando (com verificação final)

Para remover a integração:

```bash
englishup uninstall
```

## Diagnóstico

Use o comando abaixo para validar setup, chave e conectividade:

```bash
englishup doctor
```

Sem chamada de API (somente validações locais):

```bash
englishup doctor --skip-api
```

## Segurança

- Nunca commite sua chave de API.
- Prefira variável de ambiente para configurar a chave.

## Comando principal

Após instalar, o entrypoint disponível é:

```bash
englishup --help
```
