refactor(gds-examples): restructure guides/ into gds_examples/ for Pyodide compatibility#106
Merged
rororowyourboat merged 1 commit intodevfrom Mar 4, 2026
Merged
Conversation
…odide compatibility Marimo notebooks embedded in docs fail in Pyodide/WASM with ModuleNotFoundError because `guides` is a local workspace namespace not available on PyPI. Moving library modules into `gds_examples/` makes them ship with `pip install gds-examples` and importable in the browser sandbox. - guides/*/*.py library modules → gds_examples/*/ (in wheel) - guides/*/notebook.py → notebooks/*.py (flat, not in wheel) - guides/*/test_*.py → tests/ (not in wheel) - Add PEP 723 inline script metadata to all 6 notebooks - Update pyproject.toml wheel include and mypy paths - Update all docs markdown: embed paths, run commands, source links - Create merged tests/conftest.py with sys.path setup
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
guides/subpackages intogds_examples/proper so they're importable asgds_examples.getting_started,gds_examples.rosetta, etc.guides/*/notebook.pyintonotebooks/directorytests/with sharedconftest.pyMotivation
Pyodide and other environments need modules inside the installed package. Files under
guides/were siblings, not submodules ofgds_examples.Test plan
uv run --package gds-examples pytest packages/gds-examples -vuv run mkdocs build --strictuv run marimo edit packages/gds-examples/notebooks/getting_started.py