Skip to content

docs: add uvx translation example#24

Merged
fmueller merged 2 commits intomainfrom
codex/improve-installation-instructions-in-readme
Feb 3, 2026
Merged

docs: add uvx translation example#24
fmueller merged 2 commits intomainfrom
codex/improve-installation-instructions-in-readme

Conversation

@fmueller
Copy link
Owner

Motivation

  • Make it clear that users can run Scribae via uvx both normally and with the translation extra, and to surface convenient installation options (pipx/pip) and a CPU-only PyTorch pipx example.

Description

  • Update README.md to show uvx scribae --help and uvx "scribae[translation]" --help, reorder/clarify installation examples to include pipx install scribae, pip install scribae, and add the pipx install "scribae[translation]" --pip-args="--index-url https://download.pytorch.org/whl/cpu" CPU-only PyTorch example.

Testing

  • Ran uv run ruff check (passed), uv run mypy (failed due to missing torch stubs and two errors reported in src/scribae/translate/mt.py), and uv run pytest (all tests passed: 160 passed).

Codex Task

Warn users that uvx with the translation extra downloads PyTorch
(~2GB) on every run since it creates a temporary environment.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@fmueller fmueller merged commit dcda1cb into main Feb 3, 2026
3 checks passed
@fmueller fmueller deleted the codex/improve-installation-instructions-in-readme branch February 3, 2026 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant