Skip to content

Update README with usage, env vars, and behavior details#5

Merged
jianliang00 merged 1 commit into
mainfrom
codex/update-readme-based-on-repository-code
Jan 7, 2026
Merged

Update README with usage, env vars, and behavior details#5
jianliang00 merged 1 commit into
mainfrom
codex/update-readme-based-on-repository-code

Conversation

@jianliang00

Copy link
Copy Markdown
Owner

Motivation

  • Clarify how the vpython wrapper works and document common usage patterns for new users.
  • Explain dependency installation modes and how the wrapper decides when to (re)install dependencies.
  • Surface the available environment knobs (e.g. PYWRAP_BASE_PYTHON, PYWRAP_VENV_MODE) for configuration.
  • Document concurrency and venv self-healing behavior to reduce surprises during concurrent runs.

Description

  • Expanded README.md with a How it works section that outlines the runtime flow used by the wrapper.
  • Added a Usage section with example invocations such as ./python3 -c "print('hello from vpython')" and ./python3 -m pip --version.
  • Added Dependency installation modes and Environment variables sections describing requirements, pyproject, and none modes and the available PYWRAP_* settings.
  • Added Notes describing the cross-platform file lock behavior and the wrapper's venv self-heal logic and metadata file location (.venv/.pywrap/ok.json).

Testing

  • No automated tests were run because this is a documentation-only change.
  • Repository unit tests were not executed as part of this update.
  • Linting or CI was not invoked for this commit.
  • The change only modifies README.md and does not affect runtime code paths.

Codex Task

@jianliang00 jianliang00 merged commit 5c398d2 into main Jan 7, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant