qzlt 0.1.0

A Quizlet clone for the command line

qzlt

A Quizlet clone for the command line.

Built With

• Python
• Typer
• Poetry

(back to top)

Installation

PyPI

pip install qzlt

From source

With Poetry installed, run

git clone https://github.com/calvincheng/qzlt.git
cd qzlt
poetry shell
poetry install

(back to top)

Usage

Quick start

Let's create a new set to start learning some common Chinese vocabulary. Run

quiz sets create

Title: chinese
Description: Common expressions in Chinese

and follow the prompts to give your set a title and a description.

You can see that the newly created set exists by listing all sets via

quiz sets list

TITLE               DESCRIPTION
chinese             Common expressions in Chinese

By default, new sets are empty when created. Let's change that by adding some cards. Run

quiz set add chinese

You'll be prompted to start giving your card a term and a definition.

Term: 你好
Definition: Hello
Card added

Add as many cards as you want. When you're done, press ctrl-C to exit.

To see all the cards you've just added, run

quiz set list chinese

      TERM         DEFINITION
[0]   你好          Hello
[1]   再見          Goodbye
[2]   開心          Happy
[3]   傷心          Sad
[4]   蘋果          Apple
[5]   香蕉          Banana

You're all set! To study your new set, run

quiz study chinese

To see all the study modes available, run

quiz study --help

Commands

Usage: quiz [OPTIONS] COMMAND [ARGS]...

Options:
  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it or
                        customize the installation.
  --help                Show this message and exit.

Commands:
  set    Manage an individual set
  sets   Manage all sets
  study  Begin a study session

(back to top)

Roadmap

• Import from Anki
• Collect and display statistics (review heatmap, streaks, etc.)
• Add config file to customise experience (e.g. shuffle by default)
• Smarter corrections (e.g. allow answers from either grammatical gender: professeur•e)
• Markdown support for cards
• Incorporate TTS
• Resume interrupted sessions

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Calvin Cheng - [e-mail]

Project Link: https://github.com/calvincheng/qzlt

(back to top)