Skip to content

Commit 5b3da4b

Browse files
committed
Add deprecation warning
1 parent 3533e27 commit 5b3da4b

File tree

4 files changed

+33
-3
lines changed

4 files changed

+33
-3
lines changed

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [4.0.9] - 2025-07-03
9+
10+
- Deprecating `speechmatics-python` in favor of `speechmatics-rt` for real-time transcription and 'speechmatics-batch' for batch transcription.
11+
812
## [4.0.8] - 2025-07-03
913

1014
- Patch WebsocketClient to work with any websockets version >= 10.0
@@ -38,7 +42,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3842

3943
## [4.0.1] - 2025-04-30
4044

41-
### Added
45+
### Added
4246

4347
- Support RT Multichannel and channel DZ
4448

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
1-
# 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)
1+
# Legacy Speechmatics Python Client
22

3-
Python client library and CLI for Speechmatics Realtime and Batch ASR v2 APIs.
3+
> **⚠️ WARNING: This package (`speechmatics-python`) has been deprecated.**
4+
>
5+
> - **No new features** will be added
6+
> - **Bug fixes and security patches only** until **2025-12-31**
7+
>
8+
9+
### Migration Path
10+
11+
**New Official SDKs** (at [speechmatics-python-sdk](https://github.com/speechmatics/speechmatics-python-sdk)):
412

13+
| Old Package | New Package | Purpose | Migration Guide |
14+
|-------------|-------------|---------|-----------------|
15+
| `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) |
16+
| `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) |
17+
| `speechmatics.cli` | Not available (will be released as a separate package) | | |
18+
19+
Python client library and CLI for Speechmatics Realtime and Batch ASR v2 APIs.
520

621
## Getting started
722

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ def get_version(fname):
8585
classifiers=[
8686
"Environment :: Console",
8787
"Intended Audience :: Developers",
88+
"Development Status :: 7 - Inactive",
8889
"License :: OSI Approved :: MIT License",
8990
"Operating System :: OS Independent",
9091
"Programming Language :: Python :: 3",

speechmatics/__init__.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
import warnings
2+
13
from speechmatics.client import * # noqa
24
from speechmatics.exceptions import * # noqa
35
from speechmatics.models import * # noqa
6+
7+
warnings.warn(
8+
"speechmatics-python is deprecated. Migrate to 'speechmatics-rt' for real-time "
9+
"or 'speechmatics-batch' for batch transcription. "
10+
"For more information, please visit https://github.com/speechmatics/speechmatics-python-sdk",
11+
DeprecationWarning,
12+
stacklevel=2,
13+
)

0 commit comments

Comments
 (0)