-

README.md

@@ -0,0 +1,64 @@
+## install dependencies
+
+```bash
+uv sync
+```
+
+## add dependencies
+
+```bash
+# prod dependencies
+uv add PACKAGES
+
+# dev dependencies
+uv add --dev PACKAGES
+```
+
+## import dependencies from requirements.txt
+
+```bash
+uv add --requirements requirements.txt
+```
+
+## format
+
+```bash
+uv run isort .
+uv run yapf --in-place --recursive . --parallel
+```
+
+## run
+
+```bash
+uv run --module main
+
+# or
+uv sync
+source ./.venv/bin/activate
+python -m main
+```
+
+```bash
+uv run jupyter notebook \
+  --no-browser \
+  --NotebookApp.password='' \
+  --NotebookApp.token='' \
+  --port=3000
+```
+
+## clean
+
+```bash
+rm -rf ./.venv ./dist
+
+uv cache clean
+rm -r "$(uv python dir)"
+rm -r "$(uv tool dir)"
+```
+
+## todo
+
+- `trading_gateway.submit_order(pos_diff)`
+- handle strategy that trades multiple instruments
+- leveraged buy-and-hold with position sizing
+- use asyncio to run multiple strategies concurrently