Move the asr-metrics dependencies into a 'extra' set of dependencies

.github/workflows/tests.yml

@@ -22,7 +22,7 @@ jobs:
         python-version: ${{ matrix.python-version }}
 
     - name: Install dependencies
-      run: pip3 install -r requirements.txt -r requirements-dev.txt
+      run: pip3 install -r requirements.txt -r requirements-dev.txt -r requirements-extra.txt
 
     - name: Lint
       run: make lint

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.0.0] - 2024-10-25
+
+## Changed
+
+- To use the asr and diarization metrics tools, it's now required to install speechmatics-python[all]
+
 ## [2.0.2] - 2024-10-04
 
 ## Added

README.md

@@ -317,10 +317,14 @@ A complete list of commands and flags can be found in the SDK docs at https://sp
 
 ## SM Metrics
 
-This package includes tooling for benchmarking transcription and diarization accuracy.
+This package includes optional tooling for benchmarking transcription and diarization accuracy.
 
 For more information, see the `asr_metrics/README.md`
 
+To install the optional requirements, 
+
+    pip install speechmatics-python[full]
+
 ## Testing
 
 To install development dependencies and run tests

VERSION

@@ -1 +1 @@
-2.0.2
+3.0.0

requirements-extra.txt

@@ -0,0 +1,7 @@
+jiwer
+regex
+more-itertools
+pyannote.core
+pyannote.database
+docopt
+tabulate>=0.8.9

requirements.txt

@@ -3,10 +3,3 @@ httpx[http2]~=0.23
 polling2~=0.5
 toml~=0.10.2
 tenacity~=8.2.3
-jiwer
-regex
-more-itertools
-pyannote.core
-pyannote.database
-docopt
-tabulate>=0.8.9

setup.py

@@ -68,6 +68,7 @@ def get_version(fname):
     long_description=read("README.md"),
     long_description_content_type="text/markdown",
     install_requires=read_list("requirements.txt"),
+    extras_require={"full": read_list("requirements-extra.txt")},
     tests_require=read_list("requirements-dev.txt"),
     entry_points={
         "console_scripts": [