Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(polygon): install polygon from git repo to fix websockets dependency #652

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

fix(polygon): install polygon from git repo to fix websockets dependency #652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,8 @@ data/SRNE_Minute.csv
.vscode/**
*.tmp
.env

.menv/
menv/
menv

3 changes: 2 additions & 1 deletion requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
polygon-api-client
# polygon-api-client
git+https://github.com/jjfantini/client-python.git@feat/websockets#egg=polygon-api-client
alpha_vantage
ibapi==9.81.1.post1
yfinance
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
url="https://github.com/Lumiwealth/lumibot",
packages=setuptools.find_packages(),
install_requires=[
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

category Functionality

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.

Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.

"polygon-api-client>=1.13.3",
"polygon-api-client @ git+https://github.com/jjfantini/client-python.git@feat/websockets",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

category Functionality

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.

Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

category Third-party Libraries

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.

Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.

"alpaca-py>=0.28.1",
"alpha_vantage",
"ibapi==9.81.1.post1",
Expand Down