Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thisisnttheway/anki-deck-automation

Automated Anki deck creation
https://github.com/thisisnttheway/anki-deck-automation

anki ankiconnect

Last synced: about 1 month ago
JSON representation

Automated Anki deck creation

Awesome Lists containing this project

README 

        
# Anki deck automation

This repo provides tools to automatically build and export an Anki deck.  

Will require an active AnkiConnect instance.



## Usage

The easiest way to use this tool is through a docker image:

```bash

docker run -v $(pwd):/opt thisisnttheway/anki-deck-compiler:latest   

# Containerized, the script expects  at /opt

```

- `` is the anki folder.

- `` is the absolute path of the exported deck file.

- `` is the AnkiConnect instance and must be specified as `:`.



Alternatively, the repo can be cloned and dependencies manually installed:

```bash

git clone https://github.com/ThisIsntTheWay/anki-deck-automation.git

cd anki-deck-automation

pip install -r requirements.txt

```



To assemble a deck, execute `assemble.py`:

```bash

assemble.py   

```



_Additionally, the validity of the `anki` folder can be checked by running `check.py `._



### Folder structure

The script expects the following folder structure:

```bash

anki

├── assets (OPTIONAL)

│   ├── image.png

│   └── audio.mp3

├── card

│   ├── back.html

│   ├── front.html

│   └── style.css

├── config.yaml

└── decks

    ├── Subdeck 1.csv

    └── Subdeck 2.csv

        ...

```



- `assets`

  - Media files used in the deck.

  - Optional and only used if `webserver: true` is set in `config.yaml`

- `card`

  - Card template definitions.

- `decks`

  - CSV files of decks.

    Each file gets rendered into its own subdeck, with the **file name** being the name of the deck.

    - Assuming `singleDeck: false` in `config.yaml`.

      If set to `true`, only a file called `main.csv` will be consumed.

- `config.yaml`

  - Contains deck information such as master deck name, model name and note fields.



### Configuration

The file `/anki/config.yaml` contains configuration of the script and Anki deck itself.  

It must, at minimum, contain the following:

```yaml

masterDeckName: test_deck

modelName: test_model

fields:

 - question

 - answer

```



- `masterDeckName`

  - Name of the (master) deck under which all subdecks will be stored under.

- `modelName`

  - Name of the model to create.

- `fields`

  - Fields for the model.

 

An [example `config.yaml`](https://github.com/ThisIsntTheWay/anki-deck-automation/blob/main/anki/config.yaml) can be found in `/anki`.



### Decks

Decks are defined as CSVs in `/anki/decks`.  



> [!NOTE]

> By default, the script will create subdecks using all available CSV files.  

> If `singleDeck: true` is set in the `config.yaml`, the script will instead create a single deck with the name `masterDeckName`.  

> In this case, the script will only consume a CSV file called `main.csv` in this folder.



The CSV header row contains the [fields](https://github.com/ThisIsntTheWay/anki-deck-automation/blob/a429841ff4c3492a94b0374684434bb377652ad2/anki/config.yaml#L3).  

All other rows specify the content for those fields:



```csv

question;answer;picture

My question 1;My answer 1;https://ex.com/red.png

My question 2;My answer 2;https://ex.com/green.png

My question 3;My answer 3;https://ex.com/blue.png

```



> [!WARNING]  

> By default, the script assumes the `;` delimiter.  

> To change this, `csvDelimiter` in `config.yaml` can be set to a different value.  

> Only fields that are specified in `config.yaml` will actually be included in notes, apart from `tags` (See below).



#### Tags

To add tags to notes, add them into the field `tags` in a CSV.  

Tags are separated using `,`.



> [!NOTE]

> It is not necessary to add `tags` to the fields in `config.yaml`.  

> Additionally, whitespaces will be stripped.  



### Media

To add pictures/audio, create new fields containing either `image` or `audio` in their name (case insensitive).  

For example, the following field names would create an **audio** field:  

- `Audio`

- `AudioSentence`

- `sentenceAudio`

- `auxilliaryaudio`

- `audio_word`



In the CSV, add URLs containing the respective media.  

AnkiConnect will then use this URL to download the asset:



```csv

image_fieldX;audio_fieldY

https://ex.com/example.jpg;https://ex.com/example.mp3

```



> [!NOTE]

> The script will check URLs before downloading them.  

> If the URL does not respond or does not return a media type, then the field gets skipped in the note.  

> This behaviour can be changed in `config.yaml` (shown are the defaults if not specified otherwise):



```yaml

urlCheck:

  # Enable URL check

  enabled: true

  # Timeout, in seconds, of URL check

  timeout: 1

```



#### Local media

If media only exists locally, a webserver can be launched that serves all files under `./anki/assets`.  

The webserver can be configured in the `config.yaml` as such (shown are the defaults if not specified otherwise):  



```yaml

webserver:

  # Enable webserver

  enabled: true

  # Listen port

  port: 1233

  # Listen address

  listenAddress: 0.0.0.0

```



Assets can the be accessed at `http://:/`.  

(E.g. `http://localhost:1233/file.mp3`)