Metadata-Version: 2.5
Name: oboeru
Version: 0.2.0
Summary: Addictive terminal kanji quiz (TUI) on KANJIDIC2 data
License-Expression: MIT
Requires-Python: >=3.10
Requires-Dist: pillow>=12
Requires-Dist: textual>=8.2.8
Description-Content-Type: text/markdown

# oboeru （覚える）

*Oboeru* is Japanese for "to memorize / learn by heart" — which is exactly what
this terminal kanji quiz helps you do. Fast, keyboard-driven, and just
addictive enough to keep you coming back.

Built with [textual](https://textual.textualize.io/) on
[KANJIDIC2](https://www.edrdg.org/wiki/index.php/KANJIDIC_Project) data.

## Features

- Rounds of 10 multiple-choice "kanji → meaning" questions per JLPT level (N5–N1)
- Big half-block kanji art (needs a system CJK font; falls back to plain text)
- Adaptive selection: unseen and previously missed kanji come back more often
  (Leitner boxes), mastered kanji fade away
- Sessions are saved: per-kanji progress + session history in a small SQLite
  file; the menu shows lifetime accuracy and mastered count
- Score with streak bonuses 🔥, animations, and a review list after each round

## Install

```bash
pip install oboeru
# or run directly without installing:
uvx oboeru
```

The KANJIDIC2 database (built by
[k2sqlite](https://github.com/trygu/k2sqlite)) is bundled with the package,
so no setup is needed. Pass `--db /path/to/kanjidic2.sqlite` if you have your
own copy.

## Run

```bash
oboeru
oboeru --help        # all options (--db, --kanji-size, --progress)
```

Keys: `1-4` or `↑/↓` + `enter` answer, `enter` next question, `q` back/quit.

Progress is stored in `~/.oboeru/quiz_progress.sqlite` (or next to a custom
`--db` database) unless `--progress` says otherwise — your streaks survive
restarts.

## License

MIT
