Skip to content

fix(docs): run the Python quickstart offline and make it match the SDK #200

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

Merged
truthixify merged 2 commits into from
Oct 18, 2026
Merged

fix(docs): run the Python quickstart offline and make it match the SDK #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
749c1cb
fix(docs): make the Python quickstart match the SDK and the v2 announcer
zemishyrius-sketch Oct 17, 2026
978ba13
ci(docs): run the Python quickstart offline with pinned dependencies
zemishyrius-sketch 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
23 changes: 23 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,29 @@ request must hit a route documented on the page, and each fixture is compiled wi
When an example calls an endpoint, add one fixture per request it makes. `no-check`
is not allowed on that page.

### Python quickstart

`guides/quickstarts/python.mdx` runs end to end in CI, offline, as part of
`check:snippets-extended`:

```bash
npm run check:python-quickstart
```

`scripts/python-quickstart/run_quickstart.py` builds `wraith_crypto.py` from the
fence that starts with `# wraith_crypto.py` (plus any `# Add to wraith_crypto.py`
fences), then runs every other Python fence in page order in one session. The
Soroban RPC, Horizon, and Soroban transaction calls go to local fakes that serve
recorded announcer events and verify each transaction's signatures. Results are
compared with `scripts/python-quickstart/vectors.json`, which
`npm run generate:python-quickstart-vectors` computes from the pinned SDK.

Dependencies are pinned in `scripts/python-quickstart/requirements.txt`. The
`--bootstrap` flag creates a virtualenv with those pins under
`node_modules/.cache`. Every Python fence in the guide must run. A fence that
cannot run needs both words after the language, `python Pseudocode no-check`, so
readers see it is pseudocode.

## Navigation coverage

Every `.mdx` page in the shipped taxonomy (root pages plus `architecture/`,
Expand Down
Loading
Loading