Add deprecation warning

Author: dumitrugutu

README.md

@@ -1,7 +1,22 @@
-# speechmatics-python   ![Tests](https://github.com/speechmatics/speechmatics-python/workflows/Tests/badge.svg) [![License](https://img.shields.io/badge/license-MIT-yellow.svg)](https://github.com/speechmatics/speechmatics-python/blob/master/LICENSE.txt) ![PythonSupport](https://img.shields.io/badge/Python-3.7%2B-green)
+# Legacy Speechmatics Python Client
 
-Python client library and CLI for Speechmatics Realtime and Batch ASR v2 APIs.
+> **⚠️ WARNING: This package (`speechmatics-python`) has been deprecated.**
+>
+> - **No new features** will be added
+> - **Bug fixes and security patches only** until **2025-12-31**
+>
+
+### Migration Path
+
+**New Official SDKs** (at [speechmatics-python-sdk](https://github.com/speechmatics/speechmatics-python-sdk)):
 
+| Old Package | New Package | Purpose | Migration Guide |
+|-------------|-------------|---------|-----------------|
+| `speechmatics-python` | [`speechmatics-batch`](https://pypi.org/project/speechmatics-batch) | Batch transcription | [📖 Batch Migration Guide](https://github.com/speechmatics/speechmatics-python-sdk/blob/main/sdk/batch/MIGRATION.md) |
+| `speechmatics-python` | [`speechmatics-rt`](https://pypi.org/project/speechmatics-rt) | Real-time transcription | [📖 RT Migration Guide](https://github.com/speechmatics/speechmatics-python-sdk/blob/main/sdk/rt/MIGRATION.md) |
+| `speechmatics.cli` | Not available (will be released as a separate package) | | |
+
+Python client library and CLI for Speechmatics Realtime and Batch ASR v2 APIs.
 
 ## Getting started
 

VERSION

@@ -1 +1 @@
-4.0.4
+4.0.5

asr_metrics/wer/normalizers/basic.py

@@ -59,7 +59,9 @@ def remove_symbols_and_diacritics(self, s: str, keep=""):
                     else (
                         ""
                         if unicodedata.category(c) == "Mn"
-                        else " " if unicodedata.category(c)[0] in "MSP" else c
+                        else " "
+                        if unicodedata.category(c)[0] in "MSP"
+                        else c
                     )
                 )
             )

setup.py

@@ -85,6 +85,7 @@ def get_version(fname):
     classifiers=[
         "Environment :: Console",
         "Intended Audience :: Developers",
+        "Development Status :: 7 - Inactive",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
         "Programming Language :: Python :: 3",

speechmatics/__init__.py

@@ -1,3 +1,12 @@
+import warnings
+
 from speechmatics.client import *  # noqa
 from speechmatics.exceptions import *  # noqa
 from speechmatics.models import *  # noqa
+
+warnings.warn(
+    "DEPRECATION: speechmatics-python is deprecated."
+    "Please migrate to 'speechmatics-rt' for real-time or 'speechmatics-batch' for batch transcription.",
+    DeprecationWarning,
+    stacklevel=2,
+)

speechmatics/client.py

@@ -150,13 +150,13 @@ def _set_recognition_config(self):
             "transcription_config": self.transcription_config.as_config(),
         }
         if self.transcription_config.translation_config is not None:
-            msg["translation_config"] = (
-                self.transcription_config.translation_config.asdict()
-            )
+            msg[
+                "translation_config"
+            ] = self.transcription_config.translation_config.asdict()
         if self.transcription_config.audio_events_config is not None:
-            msg["audio_events_config"] = (
-                self.transcription_config.audio_events_config.asdict()
-            )
+            msg[
+                "audio_events_config"
+            ] = self.transcription_config.audio_events_config.asdict()
         self._call_middleware(ClientMessageType.SetRecognitionConfig, msg, False)
         return msg
 
@@ -179,13 +179,13 @@ def _start_recognition(self, audio_settings):
         }
 
         if self.transcription_config.translation_config is not None:
-            msg["translation_config"] = (
-                self.transcription_config.translation_config.asdict()
-            )
+            msg[
+                "translation_config"
+            ] = self.transcription_config.translation_config.asdict()
         if self.transcription_config.audio_events_config is not None:
-            msg["audio_events_config"] = (
-                self.transcription_config.audio_events_config.asdict()
-            )
+            msg[
+                "audio_events_config"
+            ] = self.transcription_config.audio_events_config.asdict()
         self.session_running = True
         self._call_middleware(ClientMessageType.StartRecognition, msg, False)
         LOGGER.debug(msg)