Skip to main content

Automated Japanese vocabulary mining from anime subtitles with Anki integration

Project description

Anki Miner

PyPI version Python 3.11+ License: GPL v3 GitHub downloads GitHub stars

Turn native Japanese content into Anki vocabulary cards.

Please leave a ⭐ star if Anki Miner helped you - it helps others find it :).

Mining Demo

Anki Miner Showcase

⬇️ Full demo with sound (MP4)

Example cards

ホント いちゃいちゃ 代
⬇️ MP4 (sound) ⬇️ MP4 (sound) ⬇️ MP4 (sound)

Installation

Requirements

  • ffmpeg only if installing from pip/pipx, .deb, or from source.
  • Anki with the AnkiConnect add-on. In Anki: Tools → Add-ons → Get Add-ons, paste code 2055492159, restart.

Download

Grab the installer for your platform from the latest release:

Platform Installer Portable
Windows AnkiMiner-*-Setup.exe AnkiMiner-Windows-x86_64.zip
Linux (Debian/Ubuntu) anki-miner_*_amd64.deb AnkiMiner-*-Linux-x86_64.AppImage
Linux (other) AnkiMiner-Linux-x86_64.tar.gz
macOS (Apple Silicon) AnkiMiner-macOS-arm64.tar.gz
Install from PyPI (Python 3.11+)
pipx install anki-miner   # or: pip install anki-miner
Install from source
git clone https://github.com/0xzerolight/anki_miner.git
cd anki_miner
pip install -e .

For full development setup, see CONTRIBUTING.md.

Tabs:

  • Episode Mining: mine one video/subtitle pair with word curation.
  • Batch Mining: batch mine a folder of episode/subtitle pairs for sequential processing. Files are paired by episode number, so each folder / queue item should hold a single show (use Multi-Anime Queue for mining multiple series at a time).
  • Deck Builder: point at a folder of episode/subtitle pairs and mine the full series into one named deck. Ranked by frequency; pick how many to include (all, top N, or a coverage target) and preview before cards are created.
  • YouTube: paste one or more URLs, then mine the queue.
  • Analytics: history, series difficulty rankings, milestones, undo.
  • Settings: Anki, Media, Dictionary, Filtering, YouTube, Themes. Saved to ~/.anki_miner/gui_config.json.

Other Features

  • Extensive filtering options (i+1 filter, frequency limits, word blacklist, subtitle regex filtering, wordset filtering, and more).
  • Animated screenshots (see example card gifs).
  • Audio format options.
Built-in themes (29)
  • Ayu — Light, Mirage, Dark
  • Catppuccin — Latte (light); Frappé, Macchiato, Mocha (dark)
  • Dracula — Dracula, Alucard
  • Everforest — Light, Dark
  • GitHub — Light; Dark, Dark Dimmed
  • Gruvbox — Light Medium, Dark Medium
  • Kanagawa — Lotus (light), Wave (dark)
  • Rosé Pine — Dawn (light); Main, Moon (dark)
  • Solarized — Light, Dark
  • Standalone — Light, Dark, Sakura, Nord, One Dark, Tokyo Night

Theme licenses: LICENSE-THEMES.md. Want another theme added? Suggest in a GitHub Issue.

How It Works
  1. Read the subtitles and split Japanese into individual words.
  2. Filter to content words you don't already know.
  3. Grab a screenshot and audio clip from the video for each line.
  4. Look up definitions in your configured offline dictionaries, optionally falling back to Jisho online if enabled (slower, rate-limited).
  5. Send the finished cards to Anki.

Recommended Resources

Type Resource What you get Download Add via
Dictionary Jitendex JMdict successor; structured formatting, examples, tags Yomitan zip Add Dictionary…
Dictionary JMdict Plain glosses; smaller, faster to index Yomitan zip Add Dictionary…
Dictionary Bee's Character Dictionary Character names from your AniList/VNDB lists, with roles and descriptions Generated on site Add Dictionary…
Pitch Kanjium ~124k patterns; drop-in TSV, no import step TSV Dictionary → Pitch Accent File
Pitch アクセント辞典v2 Richer NHK notation Drive Dictionary → Pitch Accent File
Frequency JPDB v2.2 Kana All-round default for media Yomitan zip Filtering → Frequency List File
Frequency BCCWJ SUW+LUW Balanced corpus; pairs well with news/novels Yomitan zip Filtering → Frequency List File

Dictionaries are indexed once into ~/.anki_miner/dicts/ (drag to reorder the chain). The pitch and frequency pickers accept a raw CSV/TSV or a Yomitan zip, auto-converted to ~/.anki_miner/pitch_accent.csv / frequency.csv on Save. Bee's Character Dictionary builds a custom Yomitan dictionary from your AniList/VNDB media lists, so character names in the shows you mine resolve to real definitions; re-generate and re-import when your lists change.

Proper-noun filtering uses bundled name wordsets derived from JMnedict (JMdict/EDICT project, EDRDG, CC BY-SA 4.0).

Updates

Anki Miner checks GitHub for new releases on startup (toggle in Settings). When an update is available, a banner offers a one-click download of the asset that matches your install: .deb for Debian/Ubuntu, .AppImage for AppImage, the Inno installer on Windows, the macOS arm64 archive, or the release page for pip/source installs. "Skip this version" suppresses the prompt for that release; the next release prompts again.

Troubleshooting

Issue Solution
"Cannot connect to Anki" Start Anki and ensure AnkiConnect is installed.
"Deck not found" The deck is created automatically when mining starts; if you meant a different deck, update the name in Settings.
"Note type not found" Configure your note type's field names in Settings → Anki.
"ffmpeg not found" Install ffmpeg and add it to PATH.
No definitions found Add a Yomitan dictionary in Settings → Add Dictionary… (recommended), or enable the Jisho fallback (slower, rate-limited).
Audio is wrong language The tool tries Japanese audio tracks first, then falls back to the default.
Subtitles out of sync Use the subtitle offset control in the GUI (range ±300 seconds).
AV1 video won't preview In-app preview is disabled for AV1 to avoid decoder error spam. Mining still works normally — only the preview is skipped.

Contributing

Contributions are welcome — bug fixes, dictionary integrations, GUI polish, doc improvements, all sizes.

Bug reports and feature requests → Issues. General questions and discussion → Discussions.

Special Thanks

Sincere thanks to people who made exceptional contributions to the project:

StyraxBenzoin - Brilliant feature suggestions, new release testing, community building

See CONTRIBUTORS.md for everyone who has made any kind of contribution to the project.

License

GNU General Public License v3.0. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

anki_miner-2.6.2.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

anki_miner-2.6.2-py3-none-any.whl (2.4 MB view details)

Uploaded Python 3

File details

Details for the file anki_miner-2.6.2.tar.gz.

File metadata

  • Download URL: anki_miner-2.6.2.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for anki_miner-2.6.2.tar.gz
Algorithm Hash digest
SHA256 953e044fb7d42383510679cd5d5135236c3bbb86c974d6de031676f969017938
MD5 64e40a999e414126f6492544ffed06b4
BLAKE2b-256 c7740939f5960d0c4a82a44a71e0c4bfff4c25ee5e21b9b7766a0ef0643d6499

See more details on using hashes here.

Provenance

The following attestation bundles were made for anki_miner-2.6.2.tar.gz:

Publisher: publish.yml on 0xzerolight/anki_miner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file anki_miner-2.6.2-py3-none-any.whl.

File metadata

  • Download URL: anki_miner-2.6.2-py3-none-any.whl
  • Upload date:
  • Size: 2.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for anki_miner-2.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6881bbe3dbb00b58f591b63f5ecb15d3205d7b1c93b3aa180907ff8016e9c7a2
MD5 7e491b5d388e1ea90291d156a9eac922
BLAKE2b-256 f73c8c1b5d12c643f9a7a0bba7fd7832c6fc664307139a9ca3f903312b52bf98

See more details on using hashes here.

Provenance

The following attestation bundles were made for anki_miner-2.6.2-py3-none-any.whl:

Publisher: publish.yml on 0xzerolight/anki_miner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page