Skip to content

Commit ed7c00e

Browse files
Clarify Example Support for Windows
1 parent 3177017 commit ed7c00e

File tree

5 files changed

+16
-6
lines changed

5 files changed

+16
-6
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,11 @@ print("Finished")
169169

170170
There are examples for **every** API call in this SDK. You can find all of these examples in the [examples folder](https://github.com/deepgram/deepgram-python-sdk/tree/main/examples) at the root of this repo.
171171

172-
These examples provide:
172+
Before running any of these examples, then you need to take a look at the README and install the following dependencies:
173+
174+
```bash
175+
pip install -r examples/requirements-examples.txt
176+
```
173177

174178
Text to Speech:
175179

examples/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ In order to run the code in the `examples` folder, you first need to:
1313
pip install -r requirements-examples.txt
1414
```
1515

16+
| **IMPORTANT:** The microphone examples may not work out-of-the-box on Windows due to the portaudio dependency. Modifications to the example code and correct installation/configuration of the portaudio library are required.
17+
1618
## Steps to Test Your Code
1719

1820
If you are contributing changes to this SDK, you can test those changes by using the `prerecorded`, `streaming`, or `manage` "hello world"-style applications in the `examples` folder. Here are the steps to follow:

examples/streaming/async_microphone/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Live API (Real-Time) Example
22

3-
This example uses the Microphone as input in order to detect conversation insights in what is being said. This example required additional components (for the microphone) to be installed in order for this example to function correctly.
3+
This example uses the Microphone to perform real-time transcription. This example required additional components (for the microphone) to be installed in order for this example to function correctly.
44

55
## Prerequisites
66

7-
This example will only work on Linux and MacOS. Windows platforms are not supported.
7+
This example will only work on Linux and macOS. Windows platforms are not supported.
88

99
## Configuration
1010

examples/streaming/legacy_dict_microphone/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Live API (Real-Time) Example
22

3-
This example uses the Microphone as input in order to detect conversation insights in what is being said. This example required additional components (for the microphone) to be installed in order for this example to function correctly.
3+
This example uses the Microphone to perform real-time transcription. This example required additional components (for the microphone) to be installed in order for this example to function correctly.
4+
5+
## Prerequisites
6+
7+
This example will only work on Linux and macOS. Windows platforms are not supported.
48

59
## Configuration
610

examples/streaming/microphone/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Live API (Real-Time) Example
22

3-
This example uses the Microphone as input in order to detect conversation insights in what is being said. This example required additional components (for the microphone) to be installed in order for this example to function correctly.
3+
This example uses the Microphone to perform real-time transcription. This example required additional components (for the microphone) to be installed in order for this example to function correctly.
44

55
## Prerequisites
66

7-
This example will only work on Linux and MacOS. Windows platforms are not supported.
7+
This example will only work on Linux and macOS. Windows platforms are not supported.
88

99
## Configuration
1010

0 commit comments

Comments
 (0)