pyproject-runner-shim 0.3.0

Shim for pyproject-runner.

pyproject-runner-shim

pyproject-runner-shim provides a tiny convenience script to shorten the command used to execute pyproject-runner tasks from uv run rr TASK ... to rr TASK ....

pyproject-runner provides a simple, project-oriented method of defining developer scripts. It is a simple task runner, similar to taskipy or Poe the Poet, for running tasks defined in a pyproject.toml file.

Pyproject-runner-shim expects the rr shim to be executed from a uv-managed project directory or subdirectory, with or without pyproject-runner installed in the project's virtual environment. If pyproject-runner is installed in the project's virtual environment, then that version will be run using the virtual environment's python executable. Otherwise, it will use uv tool run to download and run pyproject-runner from an ephemeral environment. This offers flexibility in how projects use pyproject-runner.

Installation

Install with uv tool:

$ uv tool install pyproject-runner-shim

If uv complains that the tool bin directory is not on the PATH environment variable, use uv tool update-shell to update the PATH, or manually add it to your shell's configuration file. See the uv tool documentation for more information.

How it works

The package consists of a single rr script, mirroring the name of the main script from the pyproject-runner package, which uv installs into the uv tool bin directory. Using only the Python standard library, the script simply executes uv run -- python3 -m pyproject_runner, passing along any arguments provided to the script. This allows the shim to be used with any number of uv-based projects that may require different versions of pyproject-runner. uv automatically determines which virtual environment to used based on the current working directory. Or, if pyproject-runner isn't a project dependency, then it will be run from an ephemeral virtual environment, allowing it to be used with projects requiring python < 3.10.

Changelog

View the full changelog here.

License

pyproject-runner is licensed under a 3-Clause BSD licence.