deepgram / deepgram-python-sdk

Official Python SDK for Deepgram's automated speech recognition APIs.
https://developers.deepgram.com
MIT License
242 stars 63 forks source link

pin the version of the websockets dependency to 12 or 13 #487

Closed jjmaldonis closed 6 days ago

jjmaldonis commented 6 days ago

Proposed changes

Users who install or upgrade this SDK are affected by #483. This PR pins the websocket dependency to v12 or v13, both of which are compatible with the current codebase.

Types of changes

What types of changes does your code introduce to the community Python SDK? Put an x in the boxes that apply

Checklist

Put an x in 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

Summary by CodeRabbit

coderabbitai[bot] commented 6 days ago

Walkthrough

The changes involve an update to the setup.py file, specifically modifying the install_requires section. The version constraint for the websockets package has been changed from websockets>=12.0 to websockets>=12.0,<14.0, which restricts the installation to versions of the package that are greater than or equal to 12.0 but less than 14.0.

Changes

File Change Summary
setup.py Updated install_requires for websockets from websockets>=12.0 to websockets>=12.0,<14.0

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Installer
    participant PackageRepo

    User->>Installer: Install package
    Installer->>PackageRepo: Fetch websockets>=12.0,<14.0
    PackageRepo-->>Installer: Return compatible version
    Installer-->>User: Package installed

šŸ“œ Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
šŸ“„ Commits Reviewing files that changed from the base of the PR and between 2887e93fa9038f0b99c50cfb6838854d4b5a65a1 and ed719943025b4135c9e0ca7e6ed919885925e120.
šŸ“’ Files selected for processing (1) * `setup.py` (1 hunks)
šŸ”‡ Additional comments (2)
setup.py (2) `31-31`: **LGTM! Version constraint effectively pins to v12/v13** The change to `websockets>=12.0,<14.0` appropriately restricts the dependency to versions 12.x and 13.x, which aligns with the PR objective and helps prevent potential compatibility issues with version 14.0+. --- `31-31`: **Verify security advisories for websockets v12.x and v13.x** Let's ensure we're not pinning to versions with known vulnerabilities.
āœ… Verification successful **No security vulnerabilities found in websockets v12.x and v13.x** Based on the results: - Latest versions available: 12.0, 13.0, 13.0.1, and 13.1 - Only two known vulnerabilities exist: - One affecting versions >= 4.0, < 5.0 - Another affecting versions < 9.1 The version constraint "websockets>=12.0,<14.0" is safe as it's well above the versions affected by known vulnerabilities.
šŸ Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Check for security advisories for websockets package versions 12.x and 13.x # Check PyPI for latest versions in the allowed range echo "Latest versions on PyPI:" curl -s https://pypi.org/pypi/websockets/json | \ jq -r '.releases | keys[]' | \ grep -E '^1[23]\.' | sort -V # Check for security advisories echo -e "\nSecurity advisories:" gh api graphql -f query=' { securityVulnerabilities(first: 10, ecosystem: PIP, package: "websockets") { nodes { advisory { summary severity publishedAt } vulnerableVersionRange firstPatchedVersion { identifier } } } }' ``` Length of output: 1042

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?

ā¤ļø Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
šŸŖ§ Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.