Actuarial Anki Deck(s)

Built upon the wonderful work by kerrickstaley/genanki.

Intended Audience: Anybody studying for Actuarial Exams

Required Background:

Familiarity with Anki
Basic navigation of Git/GitHub

Methodology

The idea of this repo is that users can create, upload, and share Anki decks as plaintext files (for version control) that would be bundled as an Anki notes deck (.apkg file) and pushed to some centralized location.

Layout

The decks are currently planned to be laid out as follows:

├───CAS
│   └───{Exam}
│       └───SourceNotes
│               Anki Deck Name.YAML
│               Other Anki Deck Name.YAML
│               Another Anki Deck Name.YAML
│
└───SOA
    └───{Exam}
        └───SourceNotes
                Anki Deck Name.YAML
                Other Anki Deck Name.YAML
                Another Anki Deck Name.YAML

Under either the SOA or the CAS folder, a subfolder should exist for each exam that has any decks. Within that exam subfolder, each deck should be saved as a separate YAML file under a SourceNotes directory.

Usage

Creating a new deck

Currently, decks are defined via YAML files.

Formatting of the cards in the deck is defined in the css files under ./assets/css. To create styling for a card, the desired stylesheet can be read into the css attribute of genanki.Model()

After creating your desired deck and ensuring it is properly formatted, make a PR and await its approval.

Using a deck from this repo

Using Locally:

Currently the best way to use one of these decks is to clone this repository and do a little bit of work in the terminal.

1. Install requirements

py -m venv .venv && . .venv/Scripts/activate
pip install -r requirements.txt

2. Generate the deck(s)

py ./generate_decks.py

3. Output

Running generate_decks.py will create Anki .apkg files in a build/ directory with the same name as the YAML files used to create them.

lathaniel / anki-actuary

readme