Alone2/studyFlash

studyFlash

A python application for learning flashcards inside your terminal (for language learning). Linux is the only supported operating system at the moment. It may work on macOS or Windows but I never tested it.

Installation

With pip

Clone the git repo and install the application:

git clone https://github.com/Alone2/studyFlash.git
sudo pip install ./studyFlash

When the command above returns an error message you can also try:

sudo pip3 install ./studyFlash or sudo python3 -m pip install ./studyFlash

Uninstall the application:

sudo pip uninstall studyFlash

Arch Linux (AUR)

studyFlash is in the AUR (link)

Install it manually or with your favorite AUR helper:

yay -S studyflash

Usage

Create a Flashcard File (.json)

studyflash new [FILENAME]

A file is being created. You can add your questions / solutions with studyflash add [FILENAME] or studyflash edit [FILENAME] (opens with text editor, default -> vim)

Add Cards to File

NOTE: It is recommended to use edit for adding cards, because you currently cannot fix typos with add.

studyflash add [FILENAME]

You need to type your questions / solutions

Import Cards from Quizlet

studyflash-quizlet QUIZLET_LINK [FILENAME]

Creates a new file with cards from Quizlet. When the file already exists, the cards are going to be added to the existing ones.

Learn Cards

studyflash study [FILENAME]

The script now asks you for your flashcards. You need to type them correctly. If you made a typo you can press "c" to count your answer as correct.

You can configure when a card counts as mastered and will not appear again.

(use ctrl+c to return to terminal)

Edit your Cards

studyflash edit [FILENAME]

Vi opens with all your cards in it. (Vi can be difficult for beginners. Change your editor like this)

You can change all the answers/questions of your flashcards. Deleting a card by renaming the answer/question to '###' is also possible.

You can also add cards by adding them at the end of the document.

Here an example file with 3 cards in it:

# When adding cards -> put them after the existing ones!
# Delete a card by replacing the question or solution with '###'
# Put an empty line between cards

A random question 
A random answer

Turtle 
Schildkröte
 
Something 
Something in another language

Change your Default Editor

Change your editor from vi to something different.

studyflash editor [FILENAME] [EDITOR]

I suggest to use nano, if you're a beginner:

studyflash editor [FILENAME] nano

Shuffle your Cards

You can either shuffle your cards manually withstudyflash shuffle [FILENAME] or enable automatic shuffling:

studyflash shuffle-auto [FILENAME]

Once enabled, you can disable automatic shuffling like this: studyflash shuffle-manual [FILENAME]

Condition for Card to be Mastered

You can configure if when a card will no longer appear and is mastered using:

studyflash condition [FILENAME]

The following explanation will appear. You can change the last line to your liking to configure when a card counts as mastered:

# It is defined here when a card counts as mastered and will 
# not be asked again. 
# (reset statistics to study cards again with: 'studyflash reset FILENAME')

# Syntax: A python boolean is defined
# You can use 'and' and 'or' to combine statements (see example 2)

# Parameters you can use:
# card.timesCorrect: How many times your answer was correct
# card.timesIncorrect: How many times your answer was incorrect
# card.timesPlayed: How many times you answered the question
# card.streak: Your current streak on how many times you're answer was correct.

# Example 1: 
# card.streak > 2
# Explanation: Card needs to be guessed correctly more than 3 times in a row:
# for it to not appear anymore and be marked as mastered

# Example 2 ():
# card.timesCorrect > card.timesIncorrect and card.timesCorrect > 2
# Explanation: You need to have guessed the card correctly more times than you guessed it incorrectly
# and the card has to be answered correctly more than 2 times for it to not appear again.

# Example 3: 
# False
# Explanation: Never sort a card out. Every card will be asked everytime 
# even if you answered the question correctly 100x times. 

# Current configuration: You need to have a streak of more or equal to 2
# and need to have answered the question correctly at least 3 times:
card.timesCorrect > 2 and card.streak >= 2

Export or Import CSV Files

You can import your csv files like this:

studyflash import [CSV FILE] [FILENAME]

Export your cards to a CSV like this:

studyflash export [FILENAME] [CSV FILE] [DELIMITER (optional)]

If you don't specify a delimiter, tabs will be used.

Reset your Statistics

studyflash reset [FILENAME]

The script resets the number of you knowing the correct/wrong answer, so you can start studying from scratch again.

Learn Words by Solution

studyflash reverse [FILENAME]

Use that command if you want to switch your solutions with your anwsers.