Skip to content

Fix venv-based Python module packaging: include meta.json in archive - #5265

Open
jeremyrose-viam wants to merge 1 commit into
viamrobotics:mainfrom
jeremyrose-viam:worktree-docs-4924-venv-meta-json
Open

Fix venv-based Python module packaging: include meta.json in archive#5265
jeremyrose-viam wants to merge 1 commit into
viamrobotics:mainfrom
jeremyrose-viam:worktree-docs-4924-venv-meta-json

Conversation

@jeremyrose-viam

Copy link
Copy Markdown
Contributor

Summary

  • DOCS-4924: the documented build.sh example for venv/PyInstaller-packaged Python modules produces a tarball missing meta.json. This breaks viam module reload/reload-local (hot-reload), which requires meta.json embedded in local tarballs — confirmed live: local tarballs must contain a meta.json with the 'entrypoint' field.
  • The registry-install path (cloud build → viam module upload) works fine either way, since metadata comes from the registry entry. The current viam module generate CLI template already produces the correct tar command; these doc examples just predate that fix.
  • Updated the build.sh example in build-modules/manage-modules.md to match the generator's actual command (meta.json + entrypoint + optional first_run file).
  • Applied the same one-line fix to 4 duplicate copies of the same example in cli/reference.md (2 live, 2 in a commented-out block).

Test plan

  • Reproduced the failure live: built the documented build.sh unmodified, deployed via reload-local to a real viam-server instance — failed with the meta.json error.
  • Confirmed the fix resolves it: same tarball + meta.json deployed successfully, sensor component constructed and responded correctly (tested against a live webcam reading — brightness dropped from ~212 to ~1 when the camera was covered).
  • Confirmed the registry path was never broken (control test): same meta.json-less tarball installed via the registry worked without issue.

…n modules

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@netlify

netlify Bot commented Aug 14, 2026

Copy link
Copy Markdown

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 780e609
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6a7f8581f1aafb0008aab569
😎 Deploy Preview https://deploy-preview-5265--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 40 (🔴 down 6 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (🟢 up 8 from production)
SEO: 92 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Aug 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to build This pull request is marked safe to build from a trusted zone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants