Nihongo Flashcard Visualizer

Nihongo Japanese Dictionary Application Flashcard Progress Visualizer, or as Nihongo Flashcard Visualizer, the name of the repository.

This repository contains code of the command line application in rendering and visualizing charts of your Nihongo flashcard progress.

Nihongo Application

Nihongo is a Japanese dictionary and flashcard application available on iOS devices.

Download on AppStore (Requires iOS 12.4 or newer)

System Requirements

Nihongo Flashcard Visualizer requires Python 3.6 or newer, with pygal and scikit-learn library installed.

This application is not guaranteed to be able to run on Windows. However, it works fine on MacOS Catalina (10.15).

Installing Python

Python can be installed from various sources, recommended methods are python.org and anaconda.com.

Installing Libraries

Install with requirements.txt

pip install -r requirements.txt

Install the library directly

pip install pygal
pip install scikit-learn

User Manual

Setting Up

Run setup.sh first. After setting up, run run.sh or use Python to run main.py to run the application.

Requirements

This application requires your Nihongo backup file placed in the application folder, the file should be named as NihongoBackup.nihongodata, the default name.

Extraction

Rendering charts requires Flashcards.sqlite to be extracted from your Nihongo backup file.

Extraction can be done by typing the command extract or simply e then hit enter/return key while the app is being runned. This will extract the required Flashcards.sqlite into the application folder.

Flashcards.sqlite is the file which stores your flashcard progress, charts rendering process is based on this file.

However, overwriting the Nihongo backup file does not update the Flashcards.sqlite file. This can be done by re-extracting after the Nihongo backup file is replaced with a new one.

If a chart rendering process is attempted without the Flashcards.sqlite file presented, it will be extracted automatically.

Chart Styles

Without coding or code modification, charts can be rendered with an option out of 15 chart styles.

The followings are all available chart styles, all are based on pygal built-in styles. If no specific chart style is configured, DefaultStyle will be used.

DefaultStyle
DarkStyle
NeonStyle
DarkSolarizedStyle
LightSolarizedStyle
LightStyle
CleanStyle
RedBlueStyle
DarkColorizedStyle
LightColorizedStyle
TurquoiseStyle
LightGreenStyle
DarkGreenStyle
DarkGreenBlueStyle
BlueStyle

References: pygal.org/en/stable/documentation/builtin_styles.html

Screenshots

The actual product may differ from screenshots due to not being up-to-date.

Command Line Application

Charts Rendering

Learned Words by Level

Word Progress

Estimated Flashcards Per Day