Update README with usage, env vars, and behavior details#5
Merged
Merged
Conversation
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.
Motivation
vpythonwrapper works and document common usage patterns for new users.PYWRAP_BASE_PYTHON,PYWRAP_VENV_MODE) for configuration.Description
README.mdwith aHow it workssection that outlines the runtime flow used by the wrapper.Usagesection with example invocations such as./python3 -c "print('hello from vpython')"and./python3 -m pip --version.Dependency installation modesandEnvironment variablessections describingrequirements,pyproject, andnonemodes and the availablePYWRAP_*settings.Notesdescribing the cross-platform file lock behavior and the wrapper's venv self-heal logic and metadata file location (.venv/.pywrap/ok.json).Testing
README.mdand does not affect runtime code paths.Codex Task