Skip to content

Commit

Permalink
Clarify Example Support for Windows
Browse files Browse the repository at this point in the history
  • Loading branch information
davidvonthenen committed Jun 12, 2024
1 parent 3177017 commit ed7c00e
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 6 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,11 @@ print("Finished")

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.

These examples provide:
Before running any of these examples, then you need to take a look at the README and install the following dependencies:

```bash
pip install -r examples/requirements-examples.txt
```

Text to Speech:

Expand Down
2 changes: 2 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ In order to run the code in the `examples` folder, you first need to:
pip install -r requirements-examples.txt
```

| **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.

## Steps to Test Your Code

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:
Expand Down
4 changes: 2 additions & 2 deletions examples/streaming/async_microphone/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Live API (Real-Time) Example

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

## Prerequisites

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

## Configuration

Expand Down
6 changes: 5 additions & 1 deletion examples/streaming/legacy_dict_microphone/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Live API (Real-Time) Example

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

## Prerequisites

This example will only work on Linux and macOS. Windows platforms are not supported.

## Configuration

Expand Down
4 changes: 2 additions & 2 deletions examples/streaming/microphone/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Live API (Real-Time) Example

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

## Prerequisites

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

## Configuration

Expand Down

0 comments on commit ed7c00e

Please sign in to comment.