rye icon indicating copy to clipboard operation
rye copied to clipboard

Set environment variables to provide context to scripts

Open brandon-avantus opened this issue 1 year ago • 0 comments

Sets the environment variables listed below to allow scripts to have some context when determining what to do and where to do it. This also provides some information to create Python packages for experimenting with some suggested rye run features.

Environment Variables:

  • WORKING_DIR: Initial working directory. Useful in env files
  • RYE: Full path of the rye executable running the command. Useful for scripts that call rye
  • RYE_RUN_CMD: Name of the command being run. Helpful for commands that run the same script to differentiate the command or for scripts to read the command entry from pyproject.toml
  • PROJECT_ROOT: Full path of the directory containing pyproject.toml. Useful for scripts to do work relative to the project root or that need to read the pyproject.toml.
  • WORKSPACE_ROOT: Full path of the workspace. Similar to PROJECT_ROOT, but for the workspace

The variables are set on the process before processing env files so they may be used in those files.

brandon-avantus avatar Aug 10 '24 18:08 brandon-avantus