feat: Add apkg import option (#18)

* Move test data for local_import into folder

* Add apkg import option

* Install dev-requirements in gha

* Update python version to 3.9

* Run mypy without arguments in gha

* Add zstandard_wheels to repo

* Remove support for new apkg format

* Undo change to __init__ file

* Add comment

* chore: reorganize requirements

* chore: add build script, edit readme

* chore: comment out not wokring test

* chore: remove todo comments

* chore: update checks GHA

* chore: fix build script

* chore: Add note about running tests to readme

* perf: Dont create zipfile for every file in zip

* ref: Refactor tests

* Check for media file conflicts in background

.github/workflows/checks.yml

@@ -19,10 +19,13 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.8
+          python-version: 3.9
 
       - name: Install Python libraries
-        run: python -m pip install aqt mypy pyqt5-stubs types-requests types-simplejson pycryptodome
+        run: python -m pip install -r dev-requirements.txt
+
+      - name: Run the build script
+        run: python scripts/build.py
 
       - name: Run mypy
-        run: python -m mypy ./src
+        run: python -m mypy

README.md

@@ -1,18 +1,33 @@
-It may not be possible to delete the add-on during runtime.
-In that case, you will need to open the addon directory by clicking 'View Files',
-close Anki, and manually delete the addon directory.
-
 # Development
 
-Run the following code to install all required packages
+## Installing packages needed for development
+```bash
+pip install -r dev-requirements.txt
+```
+
+## Building the add-on
+```bash
+python scripts/build.py
+```
 
+## Type checking
+You need to build the add-on first:
 ```bash
-pip install --no-deps --target=./src/media_import/libs -r requirements.txt
+python scripts/build.py
 ```
 
-Run the following code to get a list of packages to add to requirements.txt
+Then you can run mypy:
+```bash
+mypy
+```
 
+## Tests
+You need to build the add-on first:
 ```bash
-pip install --target=./temp/libs <package_name>
-pip freeze --path=./temp/libs > temp_reqs.txt
+python scripts/build.py
 ```
+
+Then you can run pytest:
+```bash
+python -m pytest tests
+```

dev-requirements.txt

@@ -1,3 +1,14 @@
 -r requirements.txt
 
-git+https://github.com/andrewsanchez/[email protected]
+anki==2.1.56
+aqt==2.1.56
+
+pyqt5==5.15.5
+pyqt5-qt5==5.15.2
+pyqtwebengine==5.15.5
+pyqtwebengine-qt5==5.15.2
+pyaes==1.6.1
+types-requests==2.31.0.1
+
+git+https://github.com/ankipalace/pytest-anki.git
+mypy==0.971

mypy.ini

@@ -1,4 +1,5 @@
 [mypy]
+files = src/media_import, tests
 no_strict_optional = True
 disallow_untyped_defs = True
 exclude = (?:src/media_import/libs/)

scripts/build.py

@@ -0,0 +1,36 @@
+from pathlib import Path
+
+import _aqt
+import anki
+import subprocess
+
+
+def vendor_requirements():
+    """Install requirements into the src/media_import/libs directory."""
+    subprocess.run(
+        [
+            "python",
+            "-m",
+            "pip",
+            "install",
+            "--no-deps",
+            "--target=./src/media_import/libs",
+            "--upgrade",
+            "-r",
+            "requirements.txt",
+        ],
+        check=True,
+    )
+
+def create_init_file(module):
+    module_path = Path(module.__path__[0])
+    init_file_path = module_path / "__init__.py"
+    init_file_path.touch(exist_ok=True)
+
+
+if __name__ == "__main__":
+    vendor_requirements()
+
+    # This makes mypy type checking work on Anki versions >= 2.1.55
+    create_init_file(anki)
+    create_init_file(_aqt)

src/media_import/dialog.py

@@ -6,7 +6,7 @@
 from aqt.utils import openFolder, restoreGeom, saveGeom
 
 from .importing import ImportResult
-from .tabs import GDriveTab, ImportTab, LocalTab, MegaTab
+from .tabs import ApkgTab, GDriveTab, ImportTab, LocalTab, MegaTab
 
 
 class ImportResultDialog(QMessageBox):
@@ -34,6 +34,7 @@ def __init__(self) -> None:
         QDialog.__init__(self, mw, Qt.WindowType.Tool)
         self.setWindowTitle("Import Media")
         self.setMinimumWidth(500)
+        self.setMinimumHeight(230)
         self.setup()
         self.setup_buttons()
         restoreGeom(self, f"addon-mediaimport-import")
@@ -50,7 +51,9 @@ def setup(self) -> None:
         main_layout.addSpacing(10)
 
         self.local_tab = LocalTab(self)
-        main_tab.addTab(self.local_tab, "Local Files")
+        main_tab.addTab(self.local_tab, "Local Folder")
+        self.apkg_tab = ApkgTab(self)
+        main_tab.addTab(self.apkg_tab, "Anki Deck Package (*.apkg)")
         self.gdrive_tab = GDriveTab(self)
         main_tab.addTab(self.gdrive_tab, "Google Drive")
         self.mega_tab = MegaTab(self)