Skip to content

Commit

Permalink
Update Readme, requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
SinaKhalili committed Oct 2, 2024
1 parent 877aa7b commit 753809b
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 8 deletions.
1 change: 1 addition & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
RPC_URL=""
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ venv
**/__pycache__/
.env
.venv
pickles/*
pickles/*
cache
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,16 @@


Quick Start:
1. Run `export RPC_URL"YOUR_RPC_HERE"` in terminal for static RPC
2. Create new venv `python3 -m venv venv`
3. Activate venv `source venv/bin/activate`
1. Copy .env.example to .env and set RPC_URL
2. Create new venv `python -m venv .venv`
3. Activate venv `.venv/bin/activate`
4. Install dependencies `pip install -r requirements.txt`
5. `streamlit run src/main.py`
5. Run the frontend with `streamlit run src/main.py`
6. Run the backend with `uvicorn src.main:app --host 0.0.0.0 --port 8000`

Current Metrics:
1. Largest perp positions
2. Largest spot borrows
3. Account health distribution
4. Most levered perp positions > $1m notional
5. Most levered spot borrows > $750k notional

WIP Metrics:
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ construct==2.10.68
construct-typing==0.5.3
Deprecated==1.2.14
dnspython==2.2.1
driftpy==0.7.87
driftpy==0.7.88
Events==0.5
exceptiongroup==1.0.4
flake8==6.0.0
Expand Down

0 comments on commit 753809b

Please sign in to comment.