nrbgt / janki

create, review, and manage your spaced-repetition learning in JupyterLab

janki

What is janki?

---

• a system for mastering complex topics by reviewing topical Cards
• a JupyterLab extension for creating, viewing, and reviewing Cards
• a Jupyter Server extension for storing Cards
• a Command Line Interface for importing/exporting Cards to other formats
• free software licensed under the [BSD-3-Clause] License

How does it Work?

Install

# TBD: pip install janki

or

# TBD: conda install -c conda-forge janki

Development install

See the contributing guide.

Usage

Get Started

• Launch JupyterLab

jupyterlab

• Open the Cards sidebar
• Try out the example Deck to learn about the topics described here

Get More Cards

When viewing supported document types, the Cards sidebar will show the option to Import Cards.

Make New Cards

In Jupyter Notebooks

• When viewing a Notebook, click on the Card icon in the Notebook Toolbar to add a new Card__ to that _Cell's metadata

In Markdown

Create a

In PDF

• When viewing a PDF

Import/Export

both mechanisms support a -j/--jmespath argument, allowing for rich filtering of the Cards imported or exported. See the

• Read Cards from anki2 JSON

jupyter janki import -i my-janki.anki2.json

• Export Cards to anki2 JSON

jupyter janki export -o my-janki.anki2.json -f anki2

---

Copyright (c) 2021 University System of Georgia and janki contributors

Distributed under the terms of the BSD-3-Clause License.