DEV.md

🛠️ Developer documentation

This is a documentation file for this plugin's developers.

Dev Environment Setup

This project requires

• Lefthook
• Commitlint

1. Install the required Python version:

   pyenv install

2. Set up Pipenv:

   pipenv install --dev

3. Install Lefthook:

   lefthook install

Testing

1. Run unit tests and MyPy with testall.
2. Test supported Anki versions (2.1.49 and latest) by packaging the plugin and importing the plugin into the lowest and the newest support Anki.

Release & distribution

1. Create a release commit.

   1. Bump up the package version in imagescaler/manifest.json.
   2. Tag the release commit git tag vx.y.z && git push origin vx.y.z.

2. Use the dev/bin/package tool to create imagescaler.ankiaddon.

3. Create a GitHub release: gh release create vx.y.z imagescaler.ankiaddon.

4. Share the package on Anki.

Publishing

The plugin is published and distributed on AnkiWeb.