Skip to content

cli

anki_deck_from_text.cli

Command-line interface for anki_deck_from_text

cli 

cli(input_file, output, deck_name, separator, marker, card_model, reverse, dry_run, tags, extra_input)

Generate an Anki deck from annotations on a text file.

INPUT is the text file. OUTPUT is the desired name for the .apkg file with the deck. DECK_NAME is the deck name that will be displayed in Anki.

Source code in src/anki_deck_from_text/cli.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
@click.command(context_settings=CONTEXT_SETTINGS)
@click.version_option(version=__version__, prog_name="anki_deck_from_text")
@click.argument("input_file", metavar="INPUT", type=click.Path(exists=True))
@click.argument("output")
@click.argument("deck_name")
@click.option("--separator", default="=",
              help="Character(s) that separate the text to be written to the front and back of the cards")
@click.option("--marker", default="-",
              help="Character(s) marking this line to be included in the deck")
@click.option("--card_model", default="basic",
              type=click.Choice(list(MODELS.keys()), case_sensitive=False),
              help="Anki card model to build the deck with")
@click.option("--reverse", is_flag=True, default=False,
              help="Swap front and back of each card")
@click.option("--dry-run", "--preview", is_flag=True, default=False,
              help="Preview cards that would be generated without writing a file")
@click.option("--tags", default=None,
              help="Comma-separated tags to add to all cards")
@click.option("--extra-input", "-i", multiple=True,
              type=click.Path(exists=True),
              help="Additional input files to merge into the deck (repeatable)")
def cli(
    input_file: str,
    output: str,
    deck_name: str,
    separator: str,
    marker: str,
    card_model: str,
    reverse: bool,
    dry_run: bool,
    tags: str | None,
    extra_input: tuple[str, ...],
) -> None:
    """Generate an Anki deck from annotations on a text file.\n
    INPUT is the text file.
    OUTPUT is the desired name for the .apkg file with the deck.
    DECK_NAME is the deck name that will be displayed in Anki.
    """

    question_answer_dict = generate_question_answer_dict(
        file_path=input_file,
        separator=separator,
        marker=marker,
    )

    for extra_file in extra_input:
        extra_dict = generate_question_answer_dict(
            file_path=extra_file,
            separator=separator,
            marker=marker,
        )
        question_answer_dict.update(extra_dict)

    if reverse:
        question_answer_dict = {v: k for k, v in question_answer_dict.items()}

    if dry_run:
        for front, back in question_answer_dict.items():
            click.echo(f"Front: {front}")
            click.echo(f"Back:  {back}")
            click.echo("---")
        click.echo(f"{len(question_answer_dict)} card(s) would be generated.")
        return

    tag_list: list[str] | None = None
    if tags:
        tag_list = [t.strip() for t in tags.split(",")]

    deck = generate_deck(
        question_answer_dict=question_answer_dict,
        deck_name=deck_name,
        card_model=card_model,
        tags=tag_list,
    )

    write_package(deck, output)

    click.echo("Finished generating the deck")