fix(polygon): install polygon from git repo to fix websockets dependency #652
Conversation
![korbit-ai[bot]](https://avatars.githubusercontent.com/in/322216?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Summary by Korbit AI
Code Execution Comments
- Missing version constraints and using a GitHub branch for dependencies pose compatibility, stability, and reproducibility risks.
Files scanned
| File Path | Reviewed |
|---|---|
| setup.py | ✅ |
Explore our documentation to understand the languages and file types we support and the files we ignore.
Need a new review? Comment
/korbit-reviewon this PR and I'll review your latest changes.Korbit Guide: Usage and Customization
Interacting with Korbit
- You can manually ask Korbit to review your PR using the
/korbit-reviewcommand in a comment at the root of your PR.- You can ask Korbit to generate a new PR description using the
/korbit-generate-pr-descriptioncommand in any comment on your PR.- Too many Korbit comments? I can resolve all my comment threads if you use the
/korbit-resolvecommand in any comment on your PR.- Chat with Korbit on issues we post by tagging @korbit-ai in your reply.
- Help train Korbit to improve your reviews by giving a 👍 or 👎 on the comments Korbit posts.
Customizing Korbit
- Check out our docs on how you can make Korbit work best for you and your team.
- Customize Korbit for your organization through the Korbit Console.
Current Korbit Configuration
General Settings
Setting Value Review Schedule Automatic excluding drafts Max Issue Count 10 Automatic PR Descriptions ✅ Issue Categories
Category Enabled Naming ✅ Database Operations ✅ Documentation ✅ Logging ✅ Error Handling ✅ Systems and Environment ✅ Objects and Data Structures ✅ Readability and Maintainability ✅ Asynchronous Processing ✅ Design Patterns ✅ Third-Party Libraries ✅ Performance ✅ Security ✅ Functionality ✅ Feedback and Support
| @@ -14,7 +14,7 @@ | |||
| url="https://github.com/Lumiwealth/lumibot", | |||
| packages=setuptools.find_packages(), | |||
| install_requires=[ | |||
There was a problem hiding this comment.
Missing Version Constraints
Tell me more
What is the issue?
Missing version constraint for several dependencies which could lead to compatibility issues.
Why this matters
Unconstrained dependencies may automatically upgrade to incompatible versions, potentially breaking functionality at runtime.
| @@ -14,7 +14,7 @@ | |||
| url="https://github.com/Lumiwealth/lumibot", | |||
| packages=setuptools.find_packages(), | |||
| install_requires=[ | |||
| "polygon-api-client>=1.13.3", | |||
| "polygon-api-client @ git+https://github.com/jjfantini/client-python.git@feat/websockets", | |||
There was a problem hiding this comment.
Unstable Dependency Source
Tell me more
What is the issue?
Using a specific branch from a personal fork of polygon-api-client introduces potential stability and maintenance risks.
Why this matters
The fork could become unavailable, unmaintained, or the branch could be deleted, breaking the dependency resolution. Additionally, the fork might not receive security updates or bug fixes from the original repository.
| @@ -14,7 +14,7 @@ | |||
| url="https://github.com/Lumiwealth/lumibot", | |||
| packages=setuptools.find_packages(), | |||
| install_requires=[ | |||
| "polygon-api-client>=1.13.3", | |||
| "polygon-api-client @ git+https://github.com/jjfantini/client-python.git@feat/websockets", | |||
There was a problem hiding this comment.
Avoid installing packages from specific Git branches in setup.py.
Tell me more
In the setup.py file, the polygon-api-client package is being installed from a specific branch of a Git repository. While this might temporarily fix the issue with the websockets dependency, it can lead to problems with dependency management and reproducibility. Consider using the official package from PyPI with the required version or publishing your own package with the necessary changes.
This modifies ONLY pip installation requirement file and setup.py.
This change installs polygon-API-client from a repo branch that specifies the version of the package in my project. tool to help with dependency resolution.
Description by Korbit AI
What change is being made?
Install the
polygon-api-clientfrom a specific GitHub repository branch to address a dependency issue with websockets.Why are these changes being made?
The default
polygon-api-clientpackage has a dependency issue related to websockets, which is resolved in a branch available on a GitHub repository. This fix ensures that the project can reliably use the updated client version with the necessary websocket support, improving functionality and stability. Additionally, updates to.gitignoreensure new environment folders are not tracked.