yaml2anki

YAML to Anki converter and printable flashcard generator.

Usage

The program takes up a YAML file of a specific format and does one of the following actions.

1. Create .apkg file
2. Import to anki via AnkiConnect
3. Generate a printable document of flashcards

apkg

The following command will generate a .apkg file in the current directory.

python -m yaml2anki mydeck.yaml -o mydeck.apkg

import to anki

This option requires installation of AnkiConnect as an add-on. After installation of the add-on, close the app and launch it again so that changes can take effect. While anki instance is running, run the following command

python -m yaml2anki mydeck.yaml -i

print

The following command will generate a pdf file in the current directory.

python -m yaml2anki mydeck.yaml --pdf output.pdf

The pdf document should have an even number of pages where front and back of flashcards meet each other. After printing the document, you can cut the cards around the dashed lines to get your physical cards. Similarly, the following command generates a printable html document.

python -m yaml2anki mydeck.yaml --html output.html

input file format

The following is a simple example of a valid YAML file.

deck_name: "Python Basics"
cards:
  - front: "What is a `list` in Python?"
    back: "An ordered, mutable sequence of elements."
    tags: ["python", "data-structures"]

  - front: "How do you define a function?"
    back: "Using the <code>def</code> keyword."
    tags: ["python", "syntax"]

Refer to examples folder for more examples.