diff --git a/.github/RELEASE.md b/.github/RELEASE.md index 9b6ef51..3409583 100644 --- a/.github/RELEASE.md +++ b/.github/RELEASE.md @@ -8,8 +8,8 @@ The Speechmatics Python SDK repository contains two separate packages: - `speechmatics-rt` - Real-Time API Client - `speechmatics-batch` - Batch API Client -- `speechmatics-flow` - Flow API Client - `speechmatics-voice` - Voice Agent API Client +- `speechmatics-tts` - TTS API Client Each package is released independently with its own versioning and release workflow. @@ -91,55 +91,55 @@ To release a new version of the Batch SDK: - Update GitHub release notes - Announce the release -### 3. Flow SDK Release +### 3. Voice Agent SDK Release -To release a new version of the Flow SDK: +To release a new version of the Voice Agent SDK: 1. **Create a Release Tag** ```bash - git tag flow/v1.0.0 - git push origin flow/v1.0.0 + git tag voice/v1.0.0 + git push origin voice/v1.0.0 ``` 2. **Automated Workflow** - The `release-flow.yaml` workflow will automatically: + The `release-voice.yaml` workflow will automatically: - - Extract version from tag (e.g., `flow/v1.0.0` → `1.0.0`) + - Extract version from tag (e.g., `voice/v1.0.0` → `1.0.0`) - Run comprehensive tests across Python versions - - Update version in `sdk/flow/speechmatics/flow/__init__.py` + - Update version in `sdk/voice/speechmatics/voice/__init__.py` - Build the package - Publish to PyPI 3. **Manual Steps After Release** - Verify the package is available on PyPI - - Test installation: `pip install speechmatics-flow==1.0.0` + - Test installation: `pip install speechmatics-voice==1.0.0` - Update GitHub release notes - Announce the release -### 4. Voice Agent SDK Release +### 4. TTS SDK Release -To release a new version of the Voice Agent SDK: +To release a new version of the TTS SDK: 1. **Create a Release Tag** ```bash - git tag voice/v1.0.0 - git push origin voice/v1.0.0 + git tag tts/v1.0.0 + git push origin tts/v1.0.0 ``` 2. **Automated Workflow** - The `release-voice.yaml` workflow will automatically: + The `release-tts.yaml` workflow will automatically: - - Extract version from tag (e.g., `voice/v1.0.0` → `1.0.0`) + - Extract version from tag (e.g., `tts/v1.0.0` → `1.0.0`) - Run comprehensive tests across Python versions - - Update version in `sdk/voice/speechmatics/voice/__init__.py` + - Update version in `sdk/tts/speechmatics/tts/__init__.py` - Build the package - Publish to PyPI 3. **Manual Steps After Release** - Verify the package is available on PyPI - - Test installation: `pip install speechmatics-voice==1.0.0` + - Test installation: `pip install speechmatics-tts==1.0.0` - Update GitHub release notes - Announce the release @@ -162,8 +162,8 @@ Both packages follow semantic versioning (SemVer): - RT SDK: `rt/v{version}` (e.g., `rt/v1.0.0`) - Batch SDK: `batch/v{version}` (e.g., `batch/v1.0.0`) -- Flow SDK: `flow/v{version}` (e.g., `flow/v1.0.0`) - Voice Agent SDK: `voice/v{version}` (e.g., `voice/v1.0.0`) +- TTS SDK: `tts/v{version}` (e.g., `tts/v1.0.0`) ## Environment Setup @@ -173,8 +173,8 @@ Both packages are published to PyPI using GitHub Actions with OpenID Connect (OI - RT SDK: Uses `pypi-rt` environment - Batch SDK: Uses `pypi-batch` environment -- Flow SDK: Uses `pypi-flow` environment - Voice Agent SDK: Uses `pypi-voice` environment +- TTS SDK: Uses `pypi-tts` environment ### Required Secrets diff --git a/README.md b/README.md index 5b866f5..c66cf2d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Speechmatics Python SDK [![License](https://img.shields.io/badge/license-MIT-yellow.svg)](https://github.com/speechmatics/speechmatics-python-sdk/blob/master/LICENSE) +[![PythonSupport](https://img.shields.io/badge/Python-3.9%2B-green)](https://www.python.org/) A collection of Python clients for Speechmatics APIs packaged as separate installable packages. These packages replace the old [speechmatics-python](https://pypi.org/project/speechmatics-python) package, which will be deprecated soon. @@ -10,7 +11,7 @@ Each client targets a specific Speechmatics API (e.g. real-time, batch transcrip This repository contains the following packages: -### (Beta) Real-Time Client (`speechmatics-rt`) +### Real-Time Client (`speechmatics-rt`) A Python client for Speechmatics Real-Time API. @@ -18,7 +19,7 @@ A Python client for Speechmatics Real-Time API. pip install speechmatics-rt ``` -### (Beta) Batch Client (`speechmatics-batch`) +### Batch Client (`speechmatics-batch`) An async Python client for Speechmatics Batch API. @@ -26,15 +27,7 @@ An async Python client for Speechmatics Batch API. pip install speechmatics-batch ``` -### (Beta) Flow Client (`speechmatics-flow`) - -An async Python client for Speechmatics Flow API. - -```bash -pip install speechmatics-flow -``` - -### (Beta) Voice Agent Client (`speechmatics-voice`) +### Voice Agent Client (`speechmatics-voice`) A Voice Agent Python client for Speechmatics Real-Time API. @@ -46,7 +39,7 @@ pip install speechmatics-voice pip install speechmatics-voice[smart] ``` -### (Beta) TTS Client (`speechmatics-tts`) +### TTS Client (`speechmatics-tts`) An async Python client for Speechmatics TTS API. @@ -69,10 +62,6 @@ speechmatics-python-sdk/ │ │ ├── pyproject.toml │ │ └── README.md │ │ -│ ├── flow/ -│ │ ├── pyproject.toml -│ │ └── README.md -│ │ │ ├── voice/ │ │ ├── pyproject.toml │ │ └── README.md @@ -84,7 +73,6 @@ speechmatics-python-sdk/ ├── tests/ │ ├── batch/ │ ├── rt/ -│ ├── flow/ │ ├── voice/ │ └── tts/ │ @@ -126,7 +114,6 @@ Each package can be installed separately: ```bash pip install speechmatics-rt pip install speechmatics-batch -pip install speechmatics-flow pip install speechmatics-voice[smart] pip install speechmatics-tts ```