For add-on description, please see AnkiWeb page

Development

Setup

After cloning the project, run the following command to install ankiaddonconfig as a git submodule.

git submodule update --init --recursive

Tests & Formatting

This project uses [black], mypy, and [pytest].

black .
mypy .
# pytest . (pytest no longer works)

You will need to install the following python packages to run black, mypy and pytest

pip install aqt PyQt6 mypy black pytest

You may need to uninstall pyqt5-stubs for mypy to work correctly.

Building ankiaddon file

After cloning the repo, go into the repo directory and run the following command to install the git submodule ankiaddonconfig

git submodule update --init --remote addon/ankiaddonconfig

After installing the git submodule, run the following command to create an review_hotmouse.ankiaddon file

cd addon ; zip -r ../review_hotmouse.ankiaddon * ; cd ../