diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml index 0432ab9..8346bbb 100644 --- a/.github/workflows/pythonpackage.yml +++ b/.github/workflows/pythonpackage.yml @@ -38,9 +38,9 @@ jobs: - name: Lint with flake8 run: | # stop the build if there are Python syntax errors or undefined names - uv run flake8 jiwer --count --select=E9,F63,F7,F82 --show-source --statistics + uv run flake8 src/jiwer --count --select=E9,F63,F7,F82 --show-source --statistics # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide - uv run flake8 jiwer --count --exit-zero --max-complexity=10 --max-line-length=88 --statistics + uv run flake8 src/jiwer --count --exit-zero --max-complexity=10 --max-line-length=88 --statistics - name: Check formatting with black run: | diff --git a/docs/cli.md b/docs/cli.md index ac5d814..a1c712e 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -1,4 +1,3 @@ - JiWER provides a simple CLI, which should be available after installation. For details, see `jiwer --help`. @@ -25,5 +24,5 @@ Options: --help Show this message and exit. ``` -Note that the CLI does not support a custom pre-processing (as described below). Any pre-processing +Note that the CLI does not support custom pre-processing. Any pre-processing should be done on the text files manually before calling JiWER when using the CLI. diff --git a/docs/index.md b/docs/index.md index f13a628..72e1e93 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,13 +14,13 @@ The minimum-edit distance is calculated using [RapidFuzz](https://github.com/max # Installation -You should be able to install this package using [poetry](https://python-poetry.org/docs/): +You should be able to install this package using [uv](https://docs.astral.sh/uv/): ``` -$ poetry add jiwer +$ uv add jiwer ``` -Or, if you prefer old-fashioned pip and you're using Python >= `3.7`: +Or, if you prefer old-fashioned pip and you're using Python >= `3.8`: ```bash $ pip install jiwer diff --git a/pyproject.toml b/pyproject.toml index 6479d50..efebb7b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "jiwer" -version = "3.0.5" +version = "3.1.0" description = "Evaluate your speech-to-text system with similarity measures such as word error rate (WER)" readme = "README.md" authors = [ diff --git a/jiwer/__init__.py b/src/jiwer/__init__.py similarity index 100% rename from jiwer/__init__.py rename to src/jiwer/__init__.py diff --git a/jiwer/alignment.py b/src/jiwer/alignment.py similarity index 100% rename from jiwer/alignment.py rename to src/jiwer/alignment.py diff --git a/jiwer/cli.py b/src/jiwer/cli.py similarity index 100% rename from jiwer/cli.py rename to src/jiwer/cli.py diff --git a/jiwer/measures.py b/src/jiwer/measures.py similarity index 100% rename from jiwer/measures.py rename to src/jiwer/measures.py diff --git a/jiwer/process.py b/src/jiwer/process.py similarity index 100% rename from jiwer/process.py rename to src/jiwer/process.py diff --git a/jiwer/py.typed b/src/jiwer/py.typed similarity index 100% rename from jiwer/py.typed rename to src/jiwer/py.typed diff --git a/jiwer/transformations.py b/src/jiwer/transformations.py similarity index 100% rename from jiwer/transformations.py rename to src/jiwer/transformations.py diff --git a/jiwer/transforms.py b/src/jiwer/transforms.py similarity index 100% rename from jiwer/transforms.py rename to src/jiwer/transforms.py diff --git a/uv.lock b/uv.lock index a18b940..b4995d7 100644 --- a/uv.lock +++ b/uv.lock @@ -383,7 +383,7 @@ wheels = [ [[package]] name = "jiwer" -version = "3.0.5" +version = "3.1.0" source = { editable = "." } dependencies = [ { name = "click" },