docs(sdk-python): Sphinx + examples + changelog#2
Merged
Conversation
- Sphinx: docs/ with conf.py, index.rst, and per-module pages (autodoc + napoleon + rtd theme). docs/_build/ and _autosummary/ are git-ignored. - pyproject.toml: new [project.optional-dependencies].docs extra and [tool.hatch.envs.docs] env with sphinx-build script. - CONTRIBUTING.md: venv setup, tests, lint, examples, PR flow. - CHANGELOG.md: 2.1.0 entry (consent APIs, Sphinx, ecdsa patch, CI). - examples: split full_flow.py into four runnable scripts (01_create_beo, 02_grant_consent, 03_submit_biorecord, 04_destroy_beo).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes developer-experience gaps on the Python SDK ahead of 2.1.0.
docs/withconf.py,index.rst, and per-module pages (autodoc + napoleon + RTD theme). Build viasphinx-build docs docs/_buildorhatch run docs:build._build/and_autosummary/are git-ignored.[project.optional-dependencies].docsextra and[tool.hatch.envs.docs]environment.[2.1.0] — 2026-04-20entry synced with the TypeScript SDK version.full_flow.pyinto four focused, runnable scripts:examples/01_create_beo.pyexamples/02_grant_consent.pyexamples/03_submit_biorecord.pyexamples/04_destroy_beo.pyEach example runs in simulated mode by default (no
BSP_RELAYER_URL) and auto-promotes to live mode when the env var is set.Test plan
pip install sphinx sphinx-rtd-themesucceedssphinx-build docs docs/_buildgeneratesdocs/_build/index.html(verified locally)pytestto confirm nothing regressedpython examples/01_create_beo.pyand validates simulated output