Fix venv-based Python module packaging: include meta.json in archive - #5265
Open
jeremyrose-viam wants to merge 1 commit into
Open
Fix venv-based Python module packaging: include meta.json in archive#5265jeremyrose-viam wants to merge 1 commit into
jeremyrose-viam wants to merge 1 commit into
Conversation
…n modules Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
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
build.shexample for venv/PyInstaller-packaged Python modules produces a tarball missingmeta.json. This breaksviam module reload/reload-local(hot-reload), which requiresmeta.jsonembedded in local tarballs — confirmed live:local tarballs must contain a meta.json with the 'entrypoint' field.viam module upload) works fine either way, since metadata comes from the registry entry. The currentviam module generateCLI template already produces the correct tar command; these doc examples just predate that fix.build.shexample inbuild-modules/manage-modules.mdto match the generator's actual command (meta.json+ entrypoint + optionalfirst_runfile).cli/reference.md(2 live, 2 in a commented-out block).Test plan
build.shunmodified, deployed viareload-localto a realviam-serverinstance — failed with the meta.json error.meta.jsondeployed successfully, sensor component constructed and responded correctly (tested against a live webcam reading — brightness dropped from ~212 to ~1 when the camera was covered).