Merge pull request #3 from twardoch/feature/modernize-codebase-p1

Refactor scanners, add typed models, improve paths, and setup testing…

Author: twardoch

.github/workflows/ci.yml

@@ -22,10 +22,18 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install fire pytest
-    - name: Run tests
+        pip install fire pytest pytest-cov # Added pytest-cov for coverage
+    - name: Run tests with coverage
       run: |
         python -m pip install -e .
+        # Pytest is configured in pyproject.toml to run with --cov
+        # and output to term-missing. It also creates .coverage file.
+        pytest
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v3
+      with:
+        # token: ${{ secrets.CODECOV_TOKEN }} # Only if needed for private repos or specific cases
+        fail_ci_if_error: true # Optional: fail CI if coverage upload fails
 
   publish:
     needs: build-and-test

.pre-commit-config.yaml

@@ -60,6 +60,28 @@ repos:
   ## You can add flake8 plugins via `additional_dependencies`:
   #  additional_dependencies: [flake8-bugbear]
 
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.7.0 # Or choose the latest version
+  hooks:
+  - id: mypy
+    # You might need to specify `additional_dependencies` for mypy to find your project's dependencies
+    # e.g., additional_dependencies: [types-setuptools, types-requests]
+    # For this project:
+    additional_dependencies: [
+      types-setuptools, # For pkg_resources, etc.
+      # Add stubs for other dependencies if mypy complains and they exist
+      # types-fire, types-tqdm, types-python-benedict might not exist or be mature.
+      # For now, we'll rely on inline # type: ignore for problematic libs
+      # and the mypy config in pyproject.toml for global settings.
+      "pedalboard", # To make mypy aware of pedalboard, even if it has no stubs
+      "fire",
+      "tqdm",
+      "python-benedict"
+    ]
+    # It's good practice to also configure mypy via pyproject.toml or mypy.ini
+    # For example, to specify the Python version, follow imports, etc.
+    args: [--config-file=pyproject.toml] # Point to pyproject.toml for config
+
 ## Check for misspells in documentation files:
 # - repo: https://github.com/codespell-project/codespell
 #   rev: v2.2.5

README.md

@@ -1,5 +1,9 @@
 # Pedalboard Pluginary
 
+[![Codecov](https://codecov.io/gh/twardoch/pedalboard-pluginary/branch/main/graph/badge.svg?token=YOUR_CODECOV_TOKEN_HERE)](https://codecov.io/gh/twardoch/pedalboard-pluginary)
+<!-- Replace YOUR_CODECOV_TOKEN_HERE with the actual token from Codecov if needed, or remove the token part if your repo is public and Codecov supports tokenless uploads for it.
+The URL should also be verified once the repo is active on Codecov. -->
+
 _Pedalboard Pluginary_ is an independent Python-based package and command-line tool that scans and lists VST-3 plugins on macOS and Windows, and Audio Unit (AU) plugins on macOS. It’s intended as a companion for the _[Pedalboard](https://github.com/spotify/pedalboard)_ Python library by Spotify, but it’s not affiliated with _Pedalboard_ or Spotify.
 
 ## Features