AnkiMiningAssistant
The aim of this project is to develop a cross-platoform software to facilitate the creation of useful Anki cards while sentence mining by automatically (or manually) adding screenshots and sentence audio.
Both screenshots and audio recording are obtained using platform dependant native methods, meaning there is no need to install or setup third-party software, thus simplifying the setup process and reducing the total
NOTE: This program is still in its early stages and has not been thoroughly tested, if you encounter any problem make sure to open an Issue. Apple Silicon mac and most linux distros heve never been tested.
Demo
Features
Current
- Native system audio monitoring
- Native window screenshots
- Select specific window for screenshots
- Select screen section for screenshots
- Support multiple sessions with different settings
- Automatically show Expression and Sentence of the last anki card added
- Use AnkiConnect to facilitate deck and note-type config
- Voice detection using silero-vad
- Automatically pause monitoring after specified amount of silence and restart upon new lines received
- Automatically identify end of sentence audio
- Option to preview card info before adding to Anki
- Manually modify audio selection if necessary
- Choose different screenshot
- Modify Sentence field
- Switch between automatic and manual update of cards
- And more... (Check Usage and Configuration)
Planned
- Compiled Binary/App Bundle
- Add custom tags to anki card
- Modify which tags to include in the card preview window
- Better support for multi monitor setups
- Ability to update an older anki card instead of just the last one added
- More flexible note type fields handling
Installation
As of right now, the app is only available as a python package. In the future binaries/App bundle will be made available.
To install the python package it is recommended to use uv tool:
- Install uv
- If you are on linux you may need to install
libpipewire-0.3and thePortAudiolibrary. - run the following command in terminal
uv tool install AnkiMiningAssistant --pyhton 3.12
After installing, you can use the following command to open the application
anki-mining-assistant
Opening the app for the first time will take a while, even if nothing seems to be happening let it run. Subsequent runs should open normally.
Configuration
Here are the necessary settings for the program to work, for all other refer to the descriptions provided under each settings.
General
Make sure the WebSocket Port selected does not conflict with any other software you are using. In most cases the default will work.
Add a custom websocket server to listen to in order to receive text from the media you are mining from. Already included as default are:
- localhost:6677 (used by mpv_websocket)
- localhost:2333 (used by LunaTranslator)
Anki
Make sure AnkiConnect addon is installed on Anki.
Verify that AnkiConnect PORT matches the one in AnkiConnect settings. The default should work most of the time.
Once connection with Anki is established, Media Directory should be populated automatically.
Add your preferred Note Types by selecting them from the drop down menu and pressing the + button.
For each note type you added you need to select the matching fields
Expression: word or expression learned in the card. Will be shown in main interface for the last note addedSentence: sentence being mined. Will be shown in main interface for the last note addedSentence Audio: audio recorder from this program will be added to this fieldPicture: screenshots from this program will be added to this field
Audio
Should work with the default.
If you notice problems with the voice detection, try changing Vad Threshold between 0.1 and 0.9.
A higher value will be stricter (too high might lead to some false negatives), while a lower will be laxer (too low might lead to some false positives).
Image
Should work with the default.
If you notice problems with screenshots being cutoff or scaled wrong, try clicking the Calibrate button. This is especially necessary on linux under wayland because the program has no access to the window coordinates.
Usage
Dependencies
| Name | LICENSE |
|---|---|
| PySide6 | LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only |
| websockets | BSD-3-Clause |
| SoundCard | BSD 3-clause |
| sounddevice | MIT |
| soundfile | BSD 3-Clause License |
| torch | BSD-3-Clause |
| torchaudio | BSD-2-Clause license |
| silero-vad | MIT License |
| pillow | MIT-CMU |
| numpy | BSD-3-Clause AND 0BSD AND MIT AND Zlib AND CC0-1.0 |
| cffi | MIT |
| pyobjc | MIT |
| PyWinCtl | BSD-3-Clause |
| Xlib | GNU Lesser General Public License v2 or later (LGPLv2+) (LGPLv2+) |
| jeepney | MIT |
| pywin32 | Python Software Foundation License (PSF)*[1] |
Metadata
Release files for AnkiMiningAssistant 0.1.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ankiminingassistant-0.1.5.tar.gz | 491.5 kB | Without provenance | Details for ankiminingassistant-0.1.5.tar.gz |
Release files / ankiminingassistant-0.1.5.tar.gz
| Download URL | ankiminingassistant-0.1.5.tar.gz |
|---|---|
| Size | 491.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d23ffa10691db3e07a1d141fbb64cea9d9693c3dcd604a5196ce86e38bf5f82c
|
|
BLAKE2b-256 checksum How to use checksums |
0ecd351dfbd03a301e33e4c3517a48e85c3d9974768df201aa205dacccf12379
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.5
|
Security for AnkiMiningAssistant 0.1.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.