Update from add-on template

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = src/forms/*,src/vendor/*

.github/FUNDING.yml

@@ -1,3 +1,3 @@
 github: abdnh
 patreon: abdnh
-custom: ["https://www.buymeacoffee.com/abdnh"]
+custom: ["https://www.buymeacoffee.com/abdnh"]

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: Run checks & tests
+
+on:
+    push:
+        branches:
+            - "master"
+            - "main"
+            - "test"
+    pull_request:
+
+jobs:
+    test:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+              with:
+                  submodules: recursive
+                  fetch-depth: 0
+
+            - name: Setup Python
+              uses: actions/setup-python@v4
+              with:
+                  python-version: 3.9
+
+            - name: Install dependencies
+              run: .github/workflows/install_deps.sh
+
+            - name: Build
+              run: make
+
+            - name: Run checks
+              run: SKIP=pip-compile pre-commit run --all-files
+
+            - name: Run tests
+              run: make test

.github/workflows/create_release.yml

@@ -0,0 +1,42 @@
+name: Create Release
+
+on:
+    create:
+        tags:
+            - "*"
+permissions:
+    contents: write
+jobs:
+    create-release:
+        name: Create Release
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+              with:
+                  submodules: recursive
+                  fetch-depth: 0
+
+            - name: Setup Python
+              uses: actions/setup-python@v4
+              with:
+                  python-version: 3.9
+
+            - name: Install dependencies
+              run: .github/workflows/install_deps.sh
+
+            - name: Create packages
+              run: make vendor && make
+
+            - name: Extract changes
+              shell: bash
+              run: |
+                  python -m ankiscripts.changes ${{ github.ref }} > build/RELEASE.md
+
+            - name: Release
+              uses: softprops/action-gh-release@v1
+              if: startsWith(github.ref, 'refs/tags/')
+              with:
+                  files: build/*.ankiaddon
+                  body_path: build/RELEASE.md

.github/workflows/install_deps.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+pip install -r requirements/base.txt
+pip-sync requirements/dev.txt
+sudo apt install libxcb-xinerama0 libxcb-cursor0 libegl1

.gitignore

@@ -1,12 +1,17 @@
 __pycache__/
+*.egg-info/
 venv/
 .mypy_cache/
+.pytest_cache/
+htmlcov/
+.coverage
 ankidata/
 build/
 src/manifest.json
 src/meta.json
 src/forms/
 src/user_files/*/
-src/vendor/
+vendor/
+node_modules/
 TODO.md
-samples/
+samples/

.isort.cfg

@@ -1,3 +1,3 @@
 [settings]
 profile=black
-skip=forms,vendor,venv,ankidata,user_files
+skip=venv,ankidata,vendor,forms,user_files,build

.pre-commit-config.yaml

@@ -0,0 +1,83 @@
+exclude: "venv|vendor|build"
+default_stages: [commit]
+
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v4.4.0
+      hooks:
+          - id: trailing-whitespace
+          - id: end-of-file-fixer
+          - id: check-json
+            exclude: ".vscode(.dist)?/.*"
+          - id: check-yaml
+          - id: check-builtin-literals
+          - id: check-case-conflict
+          - id: check-docstring-first
+          - id: check-shebang-scripts-are-executable
+          - id: mixed-line-ending
+          - id: detect-private-key
+
+    - repo: https://github.com/psf/black
+      rev: 23.7.0
+      hooks:
+          - id: black
+
+    - repo: https://github.com/PyCQA/isort
+      rev: 5.12.0
+      hooks:
+          - id: isort
+
+    - repo: local
+      hooks:
+          - id: pylint
+            name: pylint
+            entry: python -m pylint src tests
+            language: system
+            types: [python]
+            require_serial: true
+          - id: mypy
+            name: mypy
+            entry: python -m mypy
+            language: system
+            types: [python]
+            require_serial: true
+          - id: pyupgrade
+            name: pyupgrade
+            entry: pyupgrade --py38-plus
+            language: system
+            types: [python]
+            require_serial: true
+          - id: pip-compile
+            name: pip-compile base
+            entry: python -m ankiscripts.update_deps --type base
+            language: system
+            files: ^(requirements/base\.(in|txt))$
+            pass_filenames: false
+            require_serial: true
+          - id: pip-compile
+            name: pip-compile bundle
+            entry: python -m ankiscripts.update_deps --type bundle
+            language: system
+            files: ^(requirements/bundle\.(in|txt))$
+            pass_filenames: false
+            require_serial: true
+          - id: pip-compile
+            name: pip-compile dev
+            entry: python -m ankiscripts.update_deps --type dev
+            language: system
+            files: ^(requirements/dev\.(in|txt))$
+            pass_filenames: false
+            require_serial: true
+
+    - repo: https://github.com/pre-commit/mirrors-prettier
+      rev: v3.0.1
+      hooks:
+          - id: prettier
+            args: ["--tab-width", "4", "--write"]
+            exclude: "ankiweb_page.html"
+            exclude_types: [python]
+
+ci:
+    autoupdate_schedule: weekly
+    skip: []
+    submodules: false

.pylintrc

@@ -1,6 +1,6 @@
 [MASTER]
 extension-pkg-whitelist=PyQt6,PyQt5
-ignore = venv|ankidata|vendor|forms|user_files
+ignore = venv,ankidata,vendor,forms,user_files,build
 
 [REPORTS]
 output-format=colorized

.pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+testpaths =
+    tests

.vscode.dist/extensions.json

@@ -0,0 +1,10 @@
+{
+    "recommendations": [
+        "ms-python.python",
+        "ms-python.pylint",
+        "ms-python.black-formatter",
+        "ms-python.isort",
+        "matangover.mypy",
+        "abdo.ankiwebify"
+    ]
+}

.vscode.dist/launch.json

@@ -0,0 +1,13 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Run add-on",
+            "type": "python",
+            "request": "launch",
+            "module": "ankiscripts.run",
+            "console": "integratedTerminal",
+            "justMyCode": true
+        }
+    ]
+}

.vscode.dist/settings.json

@@ -1,10 +1,12 @@
 {
-    "editor.formatOnSave": true,
+    "[html]": {
+        "editor.formatOnSave": false
+    },
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter"
+    },
     "editor.codeActionsOnSave": {
         "source.organizeImports": true
     },
-    "python.formatting.provider": "black",
-    "[html]": {
-        "editor.formatOnSave": false
-    }
-}
+    "editor.formatOnSave": true
+}

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [1.1.1] - 2023-05-22