Skip to content

fix: ship examples README in wheel#228

Closed
w3lld1 wants to merge 1 commit into
ARPAHLS:mainfrom
w3lld1:fix/examples-readme-wheel
Closed

fix: ship examples README in wheel#228
w3lld1 wants to merge 1 commit into
ARPAHLS:mainfrom
w3lld1:fix/examples-readme-wheel

Conversation

@w3lld1

@w3lld1 w3lld1 commented Jul 8, 2026

Copy link
Copy Markdown

Summary

Fixes #226 (Phase A): ship the examples index with the wheel so skillware examples and skillware list --examples can work for pip-only installs without relying on GitHub raw access.

Changes

  • Add skillware/examples/README.md as the packaged copy of the examples index.
  • Include it as skillware package data in pyproject.toml.
  • Update _examples_readme_path() to check the installed package copy before checkout/cwd discovery and GitHub fallback.
  • Add a regression test that verifies the packaged index path is discoverable.

Verification

  • pytest tests/test_cli.py -q
    • 43 passed in 0.42s
  • python -m build --wheel
  • Verified the built wheel contains skillware/examples/README.md.
  • Installed the built wheel into a fresh venv from /tmp and verified _load_examples_index() loads the installed packaged copy with 30 rows.

Notes

This keeps the existing GitHub raw fallback for old wheels, editable/dev layouts, and other edge cases.

@rosspeili

Copy link
Copy Markdown
Contributor

Hey @w3lld1 thanks for picking this up, but this issue has been already assigned to @riticap1318, so I would wait for him to submit his PR, or you can work together on it if he agrees. Other than that, happy to review shall riticap1318 widthraw his interest or struggle with the fix. In the meantime you can check for other open issues and try to claim them by commenting on issues before opening a PR. PRs without being claimed will only be considered if patching security issues or hotfixes that bear urgent priority labels.

@w3lld1

w3lld1 commented Jul 9, 2026

Copy link
Copy Markdown
Author

Thanks for flagging this, and sorry for missing that the issue was already assigned. I'll close this PR to avoid stepping on the existing contributor's work. Happy to reopen or collaborate if it becomes useful later.

@w3lld1

w3lld1 commented Jul 9, 2026

Copy link
Copy Markdown
Author

Closing to avoid duplicating work on an issue already assigned to another contributor.

@w3lld1 w3lld1 closed this Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feat]: Ship examples/README.md in wheel; optional skillware examples --sync fallback

2 participants