Generates a report of troublesome items from your WaniKani account. These are items that are older than 12 months (1 year!) which means they are items that have given you some trobule in keeping them locked in your brain.
Toss this CSV into any ol' spreadsheet software to get a nice overview.
Each item will contain:
- Characters
- Type (Radical | Kanji | Vocabulary)
- Date seen (first time you learned it)
- Level Encountered
- Link to the WaniKani page for said item
How you go about improving your retention of these items is entirely up to you from this point. My plan is to write them out by hand, but if you have another strategy, please let me know.
If you don't want to install global dependancies, use Poetry!
Once you've installed Poetry, change into the directory where you cloned this repo and run:
poetry install
Your dependancies are now installed. すごい！
In order to use this tool, you must provide your WaniKani API key. When running the script, you will be prompted for it (and it will be saved to a .env file).
To get your key, sign in to WaniKani and go to the Settings/API Tokens page. Your key will be there.
Generating the report is pretty simple.
# Used Poetry
poetry run python main.py
# Unpoetic (this was only tested with Python 3.9)
python main.py
The report will be saved to a file called report.csv by default.
CLI Flags:
-h, --help Get Help
-o, --out Path to save the CSV to
-k, --key Your WaniKani API Key
-m, --months Minimum amount of months since learning an item (default is 12)
Currently the system does not handle large sets of data well. This is related to trying to request too many Subject IDs in the GET params. The fix is to split the requests up, but for all my data sets it has worked fine. This may happen if you have a lot of items, and set the months threshold too low.