Skip to content

Commit 505d999

Browse files
authored
README update for Flow (#63)
* Fix to README. * Update release-sdk.yaml
1 parent 751c46c commit 505d999

File tree

2 files changed

+24
-37
lines changed

2 files changed

+24
-37
lines changed

.github/RELEASE.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ The Speechmatics Python SDK repository contains two separate packages:
88

99
- `speechmatics-rt` - Real-Time API Client
1010
- `speechmatics-batch` - Batch API Client
11-
- `speechmatics-flow` - Flow API Client
1211
- `speechmatics-voice` - Voice Agent API Client
12+
- `speechmatics-tts` - TTS API Client
1313

1414
Each package is released independently with its own versioning and release workflow.
1515

@@ -91,55 +91,55 @@ To release a new version of the Batch SDK:
9191
- Update GitHub release notes
9292
- Announce the release
9393

94-
### 3. Flow SDK Release
94+
### 3. Voice Agent SDK Release
9595

96-
To release a new version of the Flow SDK:
96+
To release a new version of the Voice Agent SDK:
9797

9898
1. **Create a Release Tag**
9999

100100
```bash
101-
git tag flow/v1.0.0
102-
git push origin flow/v1.0.0
101+
git tag voice/v1.0.0
102+
git push origin voice/v1.0.0
103103
```
104104

105105
2. **Automated Workflow**
106-
The `release-flow.yaml` workflow will automatically:
106+
The `release-voice.yaml` workflow will automatically:
107107

108-
- Extract version from tag (e.g., `flow/v1.0.0``1.0.0`)
108+
- Extract version from tag (e.g., `voice/v1.0.0``1.0.0`)
109109
- Run comprehensive tests across Python versions
110-
- Update version in `sdk/flow/speechmatics/flow/__init__.py`
110+
- Update version in `sdk/voice/speechmatics/voice/__init__.py`
111111
- Build the package
112112
- Publish to PyPI
113113

114114
3. **Manual Steps After Release**
115115
- Verify the package is available on PyPI
116-
- Test installation: `pip install speechmatics-flow==1.0.0`
116+
- Test installation: `pip install speechmatics-voice==1.0.0`
117117
- Update GitHub release notes
118118
- Announce the release
119119

120-
### 4. Voice Agent SDK Release
120+
### 4. TTS SDK Release
121121

122-
To release a new version of the Voice Agent SDK:
122+
To release a new version of the TTS SDK:
123123

124124
1. **Create a Release Tag**
125125

126126
```bash
127-
git tag voice/v1.0.0
128-
git push origin voice/v1.0.0
127+
git tag tts/v1.0.0
128+
git push origin tts/v1.0.0
129129
```
130130

131131
2. **Automated Workflow**
132-
The `release-voice.yaml` workflow will automatically:
132+
The `release-tts.yaml` workflow will automatically:
133133

134-
- Extract version from tag (e.g., `voice/v1.0.0``1.0.0`)
134+
- Extract version from tag (e.g., `tts/v1.0.0``1.0.0`)
135135
- Run comprehensive tests across Python versions
136-
- Update version in `sdk/voice/speechmatics/voice/__init__.py`
136+
- Update version in `sdk/tts/speechmatics/tts/__init__.py`
137137
- Build the package
138138
- Publish to PyPI
139139

140140
3. **Manual Steps After Release**
141141
- Verify the package is available on PyPI
142-
- Test installation: `pip install speechmatics-voice==1.0.0`
142+
- Test installation: `pip install speechmatics-tts==1.0.0`
143143
- Update GitHub release notes
144144
- Announce the release
145145

@@ -162,8 +162,8 @@ Both packages follow semantic versioning (SemVer):
162162

163163
- RT SDK: `rt/v{version}` (e.g., `rt/v1.0.0`)
164164
- Batch SDK: `batch/v{version}` (e.g., `batch/v1.0.0`)
165-
- Flow SDK: `flow/v{version}` (e.g., `flow/v1.0.0`)
166165
- Voice Agent SDK: `voice/v{version}` (e.g., `voice/v1.0.0`)
166+
- TTS SDK: `tts/v{version}` (e.g., `tts/v1.0.0`)
167167

168168
## Environment Setup
169169

@@ -173,8 +173,8 @@ Both packages are published to PyPI using GitHub Actions with OpenID Connect (OI
173173

174174
- RT SDK: Uses `pypi-rt` environment
175175
- Batch SDK: Uses `pypi-batch` environment
176-
- Flow SDK: Uses `pypi-flow` environment
177176
- Voice Agent SDK: Uses `pypi-voice` environment
177+
- TTS SDK: Uses `pypi-tts` environment
178178

179179
### Required Secrets
180180

README.md

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Speechmatics Python SDK
22

33
[![License](https://img.shields.io/badge/license-MIT-yellow.svg)](https://github.com/speechmatics/speechmatics-python-sdk/blob/master/LICENSE)
4+
[![PythonSupport](https://img.shields.io/badge/Python-3.9%2B-green)](https://www.python.org/)
45

56
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.
67

@@ -10,31 +11,23 @@ Each client targets a specific Speechmatics API (e.g. real-time, batch transcrip
1011

1112
This repository contains the following packages:
1213

13-
### (Beta) Real-Time Client (`speechmatics-rt`)
14+
### Real-Time Client (`speechmatics-rt`)
1415

1516
A Python client for Speechmatics Real-Time API.
1617

1718
```bash
1819
pip install speechmatics-rt
1920
```
2021

21-
### (Beta) Batch Client (`speechmatics-batch`)
22+
### Batch Client (`speechmatics-batch`)
2223

2324
An async Python client for Speechmatics Batch API.
2425

2526
```bash
2627
pip install speechmatics-batch
2728
```
2829

29-
### (Beta) Flow Client (`speechmatics-flow`)
30-
31-
An async Python client for Speechmatics Flow API.
32-
33-
```bash
34-
pip install speechmatics-flow
35-
```
36-
37-
### (Beta) Voice Agent Client (`speechmatics-voice`)
30+
### Voice Agent Client (`speechmatics-voice`)
3831

3932
A Voice Agent Python client for Speechmatics Real-Time API.
4033

@@ -46,7 +39,7 @@ pip install speechmatics-voice
4639
pip install speechmatics-voice[smart]
4740
```
4841

49-
### (Beta) TTS Client (`speechmatics-tts`)
42+
### TTS Client (`speechmatics-tts`)
5043

5144
An async Python client for Speechmatics TTS API.
5245

@@ -69,10 +62,6 @@ speechmatics-python-sdk/
6962
│ │ ├── pyproject.toml
7063
│ │ └── README.md
7164
│ │
72-
│ ├── flow/
73-
│ │ ├── pyproject.toml
74-
│ │ └── README.md
75-
│ │
7665
│ ├── voice/
7766
│ │ ├── pyproject.toml
7867
│ │ └── README.md
@@ -84,7 +73,6 @@ speechmatics-python-sdk/
8473
├── tests/
8574
│ ├── batch/
8675
│ ├── rt/
87-
│ ├── flow/
8876
│ ├── voice/
8977
│ └── tts/
9078
@@ -126,7 +114,6 @@ Each package can be installed separately:
126114
```bash
127115
pip install speechmatics-rt
128116
pip install speechmatics-batch
129-
pip install speechmatics-flow
130117
pip install speechmatics-voice[smart]
131118
pip install speechmatics-tts
132119
```

0 commit comments

Comments
 (0)