feat: justfile, python version fix, easier doc deploy (#106)

* fix docs

* make it easier to deploy docs, fix python version in tests

.github/workflows/pythonpackage.yml

@@ -32,8 +32,7 @@ jobs:
 
     - name: Setup dependencies
       run: |
-        uv venv 
-        uv sync --extra dev
+        uv sync --all-extras --all-groups
 
     - name: Lint with flake8
       run: |
@@ -68,8 +67,7 @@ jobs:
 
     - name: Install dependencies
       run: |
-        uv venv
-        uv sync --extra dev
+        uv sync --all-extras --all-groups
 
     - name: Test with pytest
       run: |

.github/workflows/pythonpublish.yml

@@ -9,7 +9,6 @@ on:
 
 jobs:
   deploy:
-
     runs-on: ubuntu-latest
 
     steps:
@@ -28,8 +27,7 @@ jobs:
 
     - name: Install dependencies
       run: |
-        uv venv
-        uv sync --all-extras
+        uv sync --all-extras --all-groups
 
     - name: Build and publish
       env:

docs/gen_ref_pages.py

@@ -5,11 +5,11 @@
 
 nav = mkdocs_gen_files.Nav()
 
-for path in sorted(Path("jiwer").rglob("*.py")):
-    doc_path = path.relative_to("jiwer").with_suffix(".md")
+for path in sorted(Path("src/jiwer").rglob("*.py")):
+    doc_path = path.relative_to("src/jiwer").with_suffix(".md")
     full_doc_path = Path("reference", doc_path)
 
-    module_path = path.relative_to("jiwer").with_suffix("")
+    module_path = path.relative_to("src/jiwer").with_suffix("")
     parts = list(module_path.parts)
 
     if parts[-1] == "__init__" or parts[-1] == "cli":

justfile

@@ -0,0 +1,19 @@
+test-quick:
+    uv run --group dev pytest \
+    --ignore=tests/test_large_vocab.py \
+    --ignore=tests/test_speed.py
+
+test:
+    uv run --group dev pytest
+
+serve-docs:
+    uv run --group docs mkdocs serve
+
+[confirm]
+publish-docs:
+    # make sure the remote exists
+    git remote -v | grep deploy-doc > /dev/null || git remote add deploy-docs [email protected]:jitsi/jiwer.git
+    git remote set-url deploy-docs [email protected]:jitsi/jiwer.git
+
+    # push to deploy-docs remote and gh-pages branch
+    uv run --group docs mkdocs gh-publish -r deploy-docs -b gh-pages

mkdocs.yml

@@ -18,7 +18,7 @@ plugins:
 - mkdocstrings:
     handlers:
       python:
-        paths: [jiwer]
+        paths: [src/jiwer]
         options:
           separate_signature: true
           show_root_heading: true
@@ -44,4 +44,4 @@ markdown_extensions:
 
 watch:
 - docs
-- jiwer
+- src/jiwer

pyproject.toml

@@ -16,7 +16,7 @@ license = "Apache-2.0"
 [project.scripts]
 jiwer = "jiwer.cli:cli"
 
-[project.optional-dependencies]
+[dependency-groups]
 dev = [
     "black>=24.8.0",
     "flake8>=5.0.4",