Metadata-Version: 2.5
Name: echo-words
Version: 1.8.0
Summary: Turns words into rich linguistic insights and automatically adds them to your spaced repetition system.
Project-URL: Homepage, https://andgineer.github.io/echo-words/
Project-URL: Documentation, https://andgineer.github.io/echo-words/
Author-email: Andrey Sorokin <andrey@sorokin.engineer>
License: Copyright (c) 2026 Andrey Sorokin (andrey@sorokin.engineer)
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of
        this software and associated documentation files (the “Software”), to deal in
        the Software without restriction, including without limitation the rights to use,
        copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
        Software, and to permit persons to whom the Software is furnished to do so,
        subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
        OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
        HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
        WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
        FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
        OTHER DEALINGS IN THE SOFTWARE.
License-File: LICENSE
Keywords: one,two
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.12
Requires-Dist: anki==26.8.1
Requires-Dist: click>=8.2.0
Requires-Dist: edge-tts>=7.2.0
Requires-Dist: fastapi>=0.115.0
Requires-Dist: httpx>=0.27.0
Requires-Dist: invoke>=2.2.0
Requires-Dist: lameenc>=1.8.1
Requires-Dist: llmbroker>=1.8.0
Requires-Dist: piper-tts>=1.3.0
Requires-Dist: pydantic-settings>=2.6.0
Requires-Dist: python-dotenv>=1.2.3
Requires-Dist: rich-click>=1.8.8
Requires-Dist: tomli-w>=1.2.0
Requires-Dist: uvicorn[standard]>=0.32.0
Description-Content-Type: text/markdown

[![Build Status](https://github.com/andgineer/echo-words/workflows/CI/badge.svg)](https://github.com/andgineer/echo-words/actions)
[![Coverage](https://raw.githubusercontent.com/andgineer/echo-words/python-coverage-comment-action-data/badge.svg)](https://htmlpreview.github.io/?https://github.com/andgineer/echo-words/blob/python-coverage-comment-action-data/htmlcov/index.html)
# echo-words

A private AI vocabulary tutor for every word you meet. Send a word, phrase, or
whole sentence, and echo-words explains what a dictionary will not: distinct
senses and registers, real usage, origins, and examples worth remembering. It
also creates the Anki material for you — four cards that test one selected sense
in both directions, with natural pronunciation — in the deck you already review.
echo-words explains; Anki makes you remember.

<table>
<tr>
<td align="center" valign="top"><sub><b>A word, a phrase, a sentence</b></sub><br/><img src="docs/common/images/screenshots/add-word.png" width="280"/></td>
<td align="center" valign="top"><sub><b>Analysis, audio, card in Anki</b></sub><br/><img src="docs/common/images/screenshots/card-added.png" width="280"/></td>
<td align="center" valign="top"><sub><b>A sentence, translated and explained</b></sub><br/><img src="docs/common/images/screenshots/sentence.png" width="280"/></td>
</tr>
</table>

What one word gets you:

* **an explanation, not just a translation** — distinct senses and registers,
  collocations, prepositions, common confusions, origins, and translated examples;
  a phrase is taught as a whole while its words remain available as chips
* **one selected sense, reviewed four ways** — word and context test recognition
  and production; every other sense stays one tap away from its own note
* **a real voice, not a robot** — natural-sounding audio in the app and on the cards
* **a whole sentence becomes a lesson** — echo-words translates it, explains the
  hard parts, and turns every useful word or expression into a one-tap lesson
* **a deeper entry on demand** — one tap asks the strongest model for rare senses,
  deeper etymology, near-synonyms, and the mistakes learners make
* **private and free by default** — tailnet-only, no application database, and a
  pool of free LLM providers; the optional paid model is capped

# Documentation

[echo-words](https://andgineer.github.io/echo-words/)

<details>
<summary><b>Development</b></summary>

```bash
uv sync
npm --prefix webapp ci
inv dev     # http://127.0.0.1:8080
inv test    # Python + frontend suites
inv pre     # ruff, ruff-format, pyrefly, file hygiene
```

`inv test` silently skips the frontend suite when `webapp/node_modules` is
missing, so `npm ci` is part of the setup, not an optional extra. Never call
Ruff directly — `inv pre` is the only gate that matches CI.

Deployment is `invoke` over ssh, and the frontend is built on the VM by the
deploy itself:

```bash
inv setup-app --with-host-prep   # one-time, idempotent
inv deploy --ref=main
inv status
inv logs
```

See [Development](https://andgineer.github.io/echo-words/development/) and
[Deploy to Oracle Cloud](https://andgineer.github.io/echo-words/deploy-oracle/)
in the docs.

## Reports

* [Allure test report](https://andgineer.github.io/echo-words/builds/tests/)

</details>

> Created with cookiecutter using [template](https://github.com/andgineer/cookiecutter-python-package)
