From 5fb16d246ff60e462d1cd319774e251a54396605 Mon Sep 17 00:00:00 2001 From: Nik Vaessen Date: Sat, 1 Feb 2025 14:36:58 -0500 Subject: [PATCH 1/2] fix docs --- docs/gen_ref_pages.py | 6 +++--- mkdocs.yml | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/gen_ref_pages.py b/docs/gen_ref_pages.py index 6b6348b..032573d 100644 --- a/docs/gen_ref_pages.py +++ b/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": diff --git a/mkdocs.yml b/mkdocs.yml index 83f86ef..b4cdb67 100644 --- a/mkdocs.yml +++ b/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 From 9e50209b202d89c0d1a1ecdbcca7d921eddfed39 Mon Sep 17 00:00:00 2001 From: Nik Vaessen Date: Sat, 1 Feb 2025 15:32:39 -0500 Subject: [PATCH 2/2] make it easier to deploy docs, fix python version in tests --- .github/workflows/pythonpackage.yml | 6 ++---- .github/workflows/pythonpublish.yml | 4 +--- .python-version | 1 - justfile | 19 +++++++++++++++++++ pyproject.toml | 2 +- uv.lock | 26 ++++++++++++++++---------- 6 files changed, 39 insertions(+), 19 deletions(-) delete mode 100644 .python-version create mode 100644 justfile diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml index 8346bbb..fb463ce 100644 --- a/.github/workflows/pythonpackage.yml +++ b/.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: | diff --git a/.github/workflows/pythonpublish.yml b/.github/workflows/pythonpublish.yml index 30bd82d..15f355b 100644 --- a/.github/workflows/pythonpublish.yml +++ b/.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: diff --git a/.python-version b/.python-version deleted file mode 100644 index 2c07333..0000000 --- a/.python-version +++ /dev/null @@ -1 +0,0 @@ -3.11 diff --git a/justfile b/justfile new file mode 100644 index 0000000..6058816 --- /dev/null +++ b/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 git@github.com:jitsi/jiwer.git + git remote set-url deploy-docs git@github.com: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 diff --git a/pyproject.toml b/pyproject.toml index efebb7b..216ed3a 100644 --- a/pyproject.toml +++ b/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", diff --git a/uv.lock b/uv.lock index b4995d7..4b9ead2 100644 --- a/uv.lock +++ b/uv.lock @@ -391,7 +391,7 @@ dependencies = [ { name = "rapidfuzz", version = "3.11.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.9'" }, ] -[package.optional-dependencies] +[package.dev-dependencies] dev = [ { name = "black", version = "24.8.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.9'" }, { name = "black", version = "25.1.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.9'" }, @@ -412,19 +412,25 @@ docs = [ [package.metadata] requires-dist = [ - { name = "black", marker = "extra == 'dev'", specifier = ">=24.8.0" }, { name = "click", specifier = ">=8.1.8" }, - { name = "flake8", marker = "extra == 'dev'", specifier = ">=5.0.4" }, - { name = "mkdocs", marker = "extra == 'docs'", specifier = ">=1.6.1" }, - { name = "mkdocs-gen-files", marker = "extra == 'docs'", specifier = ">=0.5.0" }, - { name = "mkdocs-literate-nav", marker = "extra == 'docs'", specifier = ">=0.6.1" }, - { name = "mkdocs-material", marker = "extra == 'docs'", specifier = ">=9.5.50" }, - { name = "mkdocstrings", extras = ["python"], marker = "extra == 'docs'", specifier = ">=0.26.1" }, - { name = "pytest", marker = "extra == 'dev'", specifier = ">=8.3.4" }, - { name = "pytest-benchmark", marker = "extra == 'dev'", specifier = ">=4.0.0" }, { name = "rapidfuzz", specifier = ">=3.9.7" }, ] +[package.metadata.requires-dev] +dev = [ + { name = "black", specifier = ">=24.8.0" }, + { name = "flake8", specifier = ">=5.0.4" }, + { name = "pytest", specifier = ">=8.3.4" }, + { name = "pytest-benchmark", specifier = ">=4.0.0" }, +] +docs = [ + { name = "mkdocs", specifier = ">=1.6.1" }, + { name = "mkdocs-gen-files", specifier = ">=0.5.0" }, + { name = "mkdocs-literate-nav", specifier = ">=0.6.1" }, + { name = "mkdocs-material", specifier = ">=9.5.50" }, + { name = "mkdocstrings", extras = ["python"], specifier = ">=0.26.1" }, +] + [[package]] name = "markdown" version = "3.7"