Skip to content

docs: isolate the published-package quickstart #127

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

Closed
stefan-jansen wants to merge 2 commits into from
Closed

docs: isolate the published-package quickstart #127

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd8d002
docs: isolate quickstart from editable checkout environments
Oct 17, 2026
e441200
Merge branch 'main' into docs/isolated-published-quickstart
stefan-jansen Oct 17, 2026
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: 4 additions & 1 deletion docs/getting-started/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,12 @@ Get the maintained example from the public repository, then run it with the publ
```bash
git clone https://github.com/ml4t/live.git
cd live
uv run --no-project --with ml4t-live python examples/shadow_mode_demo.py
uv run --isolated --no-project --with ml4t-live python examples/shadow_mode_demo.py
```

`--isolated` keeps an existing checkout environment from substituting an editable development
package for the published package.

The script defines a synthetic feed that emits one `DEMO` bar per second for 65 seconds. A moving
average strategy submits a buy or sell when its signal changes. `SafeBroker` records virtual fills
and positions under `execution_mode="shadow"`; the example broker raises if it receives a real
Expand Down
Loading