autoanki 1.1.0

Automatically make Anki Decks for Chinese text

❗️
Pull requests welcome! If you think you can improve AA in any way, open a PR!

autoanki

Tool for generating Anki flashcards to learn Chinese.

Motivation

When learning Chinese, usually the advice given is to learn the top X most common words. This is good advice, as you can get pretty far with this, however it's not perfect.

For example, Harry Potter. This book will have normal distrobution for most words, however there will be a heavy emphasis on a specialized subset of words such as Wand, Robe, Wizard, Broomstick etc. These words will show up a lot more than they would otherwise.

The intention of this package was to allow Chinese learners to move from beginner books to more advanced material. I found there was a gap in knowledge going from beginner learning books (where there is little specalized terminology), to teen novels, where each novel will generally have its own specialized terminology, making the transition tedious. This is solved by automatically making Anki decks that have this specialized terminology, so that you are able to memorize these words while continuing to make progress

Usage

autoanki is both a library and a command-line tool.

To get started, run pip install autoanki This should install all the requirements. Then, in a Python file, do from autoanki import AutoAnki

To get started, first, create a database for autoanki to use

db_path = "AutoAnki.db"
if not AutoAnki.is_database(db_path):
    AutoAnki.create_autoanki_db(db_path)

Then create an instance of autoanki using the database

aa = AutoAnki(db_path)

Add whatever books you want in your deck. These can be a single file, or a folder

bookpath = 'short-story.txt'
aa.add_book(bookpath, 'My first book😆')

Once all of your books are added, the definitions need to be found, and then you can create a deck!

aa.complete_unfinished_definitions()
aa.create_deck("AutoAnki Deck", "output")

This will automatically have the .apkg extension, which Anki uses. Import this file into Anki, and you're all set.

How it works

AutoAnki interfaces has 4 components on the back end:

1. BookCleaner: Cleans the input coming in from files that the user supplies
2. DatabaseManager: Takes the cleaned input and puts it into the database
3. Dictionary: Finds definitions for words in the database
4. DeckManager: Creates Decks

Database:

There are 3 different types of tables in the DB,

1. dictionary, which holds all the definitions and other information
2. book_list, which holds the titles of the books in the database
3. book, based off of the name of the book, and holds the words in the book to find in the dictionary

dictionary:

• word_id
• word
• word_traditional
• word_type (noun, verb, etc.)
• pinyin
• pinyin_numbers
• number_of_strokes
• sub_components
• frequency
• hsk_level
• top_level
• audio_path
• image_path
• definition

Dictionary table

book_list:

• book_name
• book_table_name
• language

Book list table

book

• book_table_word_id
• dictionary_word_id
• number_of_appearances

Book table

Planned features

• See ROADMAP.md

Other Info

If you would like to get involved, or learn more information, reading Anki documentation is really important, especially the Getting Started