Clarify Example Support for Windows #414
Conversation
|
Warning Rate limit exceeded@dvonthenen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 34 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe updates primarily focus on enhancing the documentation across various README.md files in the deepgram-python-sdk repository. These changes include adding installation instructions for dependencies, clarifications regarding platform compatibility, and ensuring consistency in platform naming conventions. No changes were made to the declarations of exported or public entities. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range and nitpick comments (8)
examples/README.md (2)
Line range hint
6-6: Consider using a more concise phrase.Instead of "In order to run the code in the
examplesfolder," consider simplifying to:- In order to run the code in the `examples` folder, + To run the code in the `examples` folder,
Line range hint
10-10: Correct the spelling of "macOS".- be using a MacOS or Linux. + be using a macOS or Linux.examples/streaming/legacy_dict_microphone/README.md (1)
Line range hint
21-21: Avoid repetition and use a hyphen for "cross-platform".- That package makes use of the [PortAudio library](http://www.portaudio.com/) which is a cross-platform open source audio library. + That package utilizes the [PortAudio library](http://www.portaudio.com/), a cross-platform, open-source audio library.Tools
LanguageTool
[style] ~3-~3: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...is example uses the Microphone as input in order to detect conversation insights in what is...
[grammar] ~7-~7: The operating system from Apple is written “macOS”. (MAC_OS)
Context: ...his example will only work on Linux and MacOS. Windows platforms are not supported. ...Markdownlint
3-3: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spacesREADME.md (5)
Line range hint
28-28: Add a comma for clarity.- To access the Deepgram API you will need a [free Deepgram API Key](https://console.deepgram.com/signup?jump=keys). + To access the Deepgram API, you will need a [free Deepgram API Key](https://console.deepgram.com/signup?jump=keys).
Line range hint
72-72: Add a comma after "However".- However you can still tweak options and settings if you need. + However, you can still tweak options and settings if you need.
Line range hint
193-193: Correct the article usage.- Transcription From an URL + Transcription From a URL
Line range hint
214-214: Add a comma for clarity.- To run each example set the `DEEPGRAM_API_KEY` as an environment variable + To run each example, set the `DEEPGRAM_API_KEY` as an environment variable
Line range hint
218-218: Simplify the expression.- This SDK provides logging as a means to troubleshoot and debug issues encountered. + This SDK provides logging to troubleshoot and debug issues encountered.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- README.md (1 hunks)
- examples/README.md (1 hunks)
- examples/streaming/legacy_dict_microphone/README.md (1 hunks)
Additional context used
LanguageTool
examples/README.md
[style] ~6-~6: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...working on this SDK. ## Prerequisites In order to run the code in theexamplesfolder, ...
[grammar] ~10-~10: The operating system from Apple is written “macOS”. (MAC_OS)
Context: ...les.txt` for the examples 2. be using a MacOS or Linux. These examples are geared tow...examples/streaming/legacy_dict_microphone/README.md
[style] ~3-~3: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...is example uses the Microphone as input in order to detect conversation insights in what is...
[grammar] ~7-~7: The operating system from Apple is written “macOS”. (MAC_OS)
Context: ...his example will only work on Linux and MacOS. Windows platforms are not supported. ...
[style] ~21-~21: You have already used this phrasing in nearby sentences. Shortening it will avoid wordiness. (REP_MAKE_USE_OF)
Context: ...ned within the repository. That package makes use of the [PortAudio library](http://www.port...
[uncategorized] ~21-~21: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...rtaudio.com/) which is a cross-platform open source audio library. If you are on Linux, you...README.md
[uncategorized] ~28-~28: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...g an API Key 🔑 To access the Deepgram API you will need a [free Deepgram API Key]...
[uncategorized] ~72-~72: A comma may be missing after the conjunctive/linking adverb ‘However’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Context: ... clients shouldn't need to know about. However you can still tweak options and setting...
[misspelling] ~193-~193: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’. (EN_A_VS_AN)
Context: ...rded/file/main.py) - Transcription From an URL - [examples/prerecorded/url](https:...
[uncategorized] ~214-~214: A comma might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
Context: ...ples/manage/usage/main.py) To run each example set theDEEPGRAM_API_KEYas an enviro...
[style] ~218-~218: To make your writing clearer, consider a more direct alternative. (AS_A_MEANS_TO)
Context: ... ## Logging This SDK provides logging as a means to troubleshoot and debug issues encountered. By defaul...
[style] ~218-~218: In American English, abbreviations like “etc.” require a period. (ETC_PERIOD)
Context: ...ages and higher (ieWarning,Error, etc) when you initialize the library as fol...
[style] ~246-~246: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...r more information. ### Prerequisites In order to develop new features for the SDK itself...
[uncategorized] ~267-~267: A comma might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
Context: ... ## Getting Help We love to hear from you so if you have questions, comments or f...
[style] ~268-~268: This expression usually appears with a “please” in front of it. (INSERT_PLEASE)
Context: ... comments or find a bug in the project, let us know! You can either: - [Open an issue in t...
Markdownlint
examples/streaming/legacy_dict_microphone/README.md
3-3: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
Additional comments not posted (1)
README.md (1)
172-176: Ensure the prerequisites are clear before running examples.The instructions are clear and direct, ensuring users know to install dependencies before proceeding with examples.
davidvonthenen
force-pushed
the
clarify-windows-support
branch
from
e827f41 to
c6b7e33
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range and nitpick comments (14)
examples/README.md (3)
Line range hint
6-6: Consider using a more concise phrase to avoid wordiness.- In order to run the code in the `examples` folder, you first need to: + To run the code in the `examples` folder, you first need to:
Line range hint
10-10: Update the platform name for consistency.- be using a MacOS or Linux. + be using a macOS or Linux.
Line range hint
38-38: Consider adding the missing article for grammatical correctness.- you can change directory into each example folder and run the example like so: + you can change the directory into each example folder and run the example like so:examples/streaming/async_microphone/README.md (2)
Line range hint
3-3: Consider using a more concise phrase to avoid wordiness.- This example uses the Microphone as input in order to detect conversation insights in what is being said. + This example uses the Microphone to detect conversation insights.
Line range hint
21-21: Avoid repetitive phrasing and consider using a hyphen for the compound adjective.- That package makes use of the [PortAudio library](http://www.portaudio.com/) which is a cross-platform open source audio library. + That package uses the [PortAudio library](http://www.portaudio.com/), a cross-platform, open-source audio library.examples/streaming/microphone/README.md (2)
Line range hint
3-3: Consider using a more concise phrase to avoid wordiness.- This example uses the Microphone as input in order to detect conversation insights in what is being said. + This example uses the Microphone to detect conversation insights.
Line range hint
21-21: Avoid repetitive phrasing and consider using a hyphen for the compound adjective.- That package makes use of the [PortAudio library](http://www.portaudio.com/) which is a cross-platform open source audio library. + That package uses the [PortAudio library](http://www.portaudio.com/), a cross-platform, open-source audio library.examples/streaming/legacy_dict_microphone/README.md (1)
Line range hint
21-21: Avoid repetitive phrasing and consider using a hyphen for the compound adjective.- That package makes use of the [PortAudio library](http://www.portaudio.com/) which is a cross-platform open source audio library. + That package uses the [PortAudio library](http://www.portaudio.com/), a cross-platform, open-source audio library.Tools
LanguageTool
[style] ~3-~3: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...is example uses the Microphone as input in order to detect conversation insights in what is...Markdownlint
3-3: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spacesREADME.md (6)
Line range hint
193-193: Correct the article usage.- Transcription From an URL + Transcription From a URL
Line range hint
214-214: Add a comma for clarity.- To run each example set the `DEEPGRAM_API_KEY` as an environment variable, then `cd` into each example folder and execute the example: `go run main.py`. + To run each example, set the `DEEPGRAM_API_KEY` as an environment, then `cd` into each example folder and execute the example: `go run main.py`.
Line range hint
218-218: Simplify the expression.- This SDK provides logging as a means to troubleshoot and debug issues encountered. + This SDK uses logging to troubleshoot and debug issues.
Line range hint
218-218: Add a period after "etc".- (ie `Warning`, `Error`, etc) when you initialize the library as follows: + (ie `Warning`, `Error`, etc.) when you initialize the library as follows:
Line range hint
246-246: Simplify the expression.- In order to develop new features for the SDK itself + To develop new features for the SDK
Line range hint
268-268: Add politeness to the call to action.- let us know! You can either: + please let us know! You can either:
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (5)
- README.md (1 hunks)
- examples/README.md (1 hunks)
- examples/streaming/async_microphone/README.md (1 hunks)
- examples/streaming/legacy_dict_microphone/README.md (1 hunks)
- examples/streaming/microphone/README.md (1 hunks)
Additional context used
LanguageTool
examples/README.md
[style] ~6-~6: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...working on this SDK. ## Prerequisites In order to run the code in theexamplesfolder, ...
[grammar] ~10-~10: The operating system from Apple is written “macOS”. (MAC_OS)
Context: ...les.txt` for the examples 2. be using a MacOS or Linux. These examples are geared tow...
[uncategorized] ~38-~38: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...ile (ie.bash_profile) you can change directory into each example folder and run the ex...examples/streaming/async_microphone/README.md
[style] ~3-~3: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...is example uses the Microphone as input in order to detect conversation insights in what is...
[style] ~21-~21: You have already used this phrasing in nearby sentences. Shortening it will avoid wordiness. (REP_MAKE_USE_OF)
Context: ...ned within the repository. That package makes use of the [PortAudio library](http://www.port...
[uncategorized] ~21-~21: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...rtaudio.com/) which is a cross-platform open source audio library. If you are on Linux, you...examples/streaming/microphone/README.md
[style] ~3-~3: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...is example uses the Microphone as input in order to detect conversation insights in what is...
[style] ~21-~21: You have already used this phrasing in nearby sentences. Shortening it will avoid wordiness. (REP_MAKE_USE_OF)
Context: ...ned within the repository. That package makes use of the [PortAudio library](http://www.port...
[uncategorized] ~21-~21: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...rtaudio.com/) which is a cross-platform open source audio library. If you are on Linux, you...examples/streaming/legacy_dict_microphone/README.md
[style] ~3-~3: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...is example uses the Microphone as input in order to detect conversation insights in what is...
[style] ~21-~21: You have already used this phrasing in nearby sentences. Shortening it will avoid wordiness. (REP_MAKE_USE_OF)
Context: ...ned within the repository. That package makes use of the [PortAudio library](http://www.port...
[uncategorized] ~21-~21: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...rtaudio.com/) which is a cross-platform open source audio library. If you are on Linux, you...README.md
[uncategorized] ~72-~72: A comma may be missing after the conjunctive/linking adverb ‘However’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Context: ... clients shouldn't need to know about. However you can still tweak options and setting...
[misspelling] ~193-~193: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’. (EN_A_VS_AN)
Context: ...rded/file/main.py) - Transcription From an URL - [examples/prerecorded/url](https:...
[uncategorized] ~214-~214: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...ples/manage/usage/main.py) To run each example set theDEEPGRAM_API_KEYas an enviro...
[style] ~218-~218: To make your writing clearer, consider a more direct alternative. (AS_A_MEANS_TO)
Context: ... ## Logging This SDK provides logging as a means to troubleshoot and debug issues encountered. By defaul...
[style] ~218-~218: In American English, abbreviations like “etc.” require a period. (ETC_PERIOD)
Context: ...ages and higher (ieWarning,Error, etc) when you initialize the library as fol...
[style] ~246-~246: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...r more information. ### Prerequisites In order to develop new features for the SDK itself...
[style] ~268-~268: This expression usually appears with a “please” in front of it. (INSERT_PLEASE)
Context: ... comments or find a bug in the project, let us know! You can either: - [Open an issue in t...
Markdownlint
examples/streaming/legacy_dict_microphone/README.md
3-3: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
Additional comments not posted (4)
examples/README.md (1)
16-16: The updated note on Windows support for microphone examples is clear and informative.examples/streaming/async_microphone/README.md (1)
7-7: The note clearly states that Windows platforms are not supported for this example.examples/streaming/microphone/README.md (1)
7-7: The note clearly states that Windows platforms are not supported for this example.examples/streaming/legacy_dict_microphone/README.md (1)
7-7: The note clearly states that Windows platforms are not supported for this example.
davidvonthenen
force-pushed
the
clarify-windows-support
branch
from
c6b7e33 to
ed7c00e
Compare
Proposed changes
Addresses: #340
This clarifies the local Microphone example support for Windows. Since they are only examples and best effort because the portaudio installation (which the user is responsible for) is a little tricky.
Types of changes
What types of changes does your code introduce to the community Python SDK?
Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Further comments
NA
Summary by CodeRabbit
legacy_dict_microphoneexample README to specify it only works on Linux and macOS.async_microphoneandmicrophoneexample READMEs.