--wheel-source -> --wheel-path

Author: brettlangdon

docs/quickstart.rst

@@ -70,12 +70,12 @@ Using Pre-built Wheels
 ----------------------
 
 By default, riot installs your project in editable mode (``pip install -e .``).
-If you want to test with pre-built wheels instead, use the ``--wheel-source`` option:
+If you want to test with pre-built wheels instead, use the ``--wheel-path`` option:
 
 .. code-block:: bash
 
         $ pip wheel --no-deps -w dist/ .
-        $ riot --wheel-source dist/ run test
+        $ riot --wheel-path dist/ run test
 
 See :doc:`wheel_sources` for more details on using pre-built wheels.
 

docs/wheel_sources.rst

@@ -11,47 +11,47 @@ pre-built wheels instead. This is useful for:
 - **Reproducibility**: Testing with exact wheel artifacts
 
 
-Specifying a Wheel Source
---------------------------
+Specifying a Wheel Path
+------------------------
 
-There are two ways to specify a wheel source:
+There are two ways to specify a wheel path:
 
 
 Command-line Option
 ~~~~~~~~~~~~~~~~~~~
 
-Use the global ``--wheel-source`` option before any subcommand:
+Use the global ``--wheel-path`` option before any subcommand:
 
 .. code-block:: bash
 
     # With a local directory containing wheels
-    riot --wheel-source /path/to/wheels run test
+    riot --wheel-path /path/to/wheels run test
 
     # With a remote URL (e.g., index.html)
-    riot --wheel-source https://example.com/wheels/ generate
+    riot --wheel-path https://example.com/wheels/ generate
 
     # Works with all commands
-    riot --wheel-source /tmp/wheels shell mypy
+    riot --wheel-path /tmp/wheels shell mypy
 
 
 Environment Variable
 ~~~~~~~~~~~~~~~~~~~~
 
-Set the ``RIOT_WHEEL_SOURCE`` environment variable:
+Set the ``RIOT_WHEEL_PATH`` environment variable:
 
 .. code-block:: bash
 
-    export RIOT_WHEEL_SOURCE=/path/to/wheels
+    export RIOT_WHEEL_PATH=/path/to/wheels
     riot run test
 
 This is particularly useful in CI/CD environments where you want to configure
-wheel sources without modifying commands.
+wheel paths without modifying commands.
 
 
 Package Name Resolution
 -----------------------
 
-When using wheel sources, riot needs to know the package name to install. It
+When using wheel paths, riot needs to know the package name to install. It
 determines this automatically by:
 
 1. **Checking the ``RIOT_PACKAGE_NAME`` environment variable** (highest priority)
@@ -72,14 +72,14 @@ For projects not using ``pyproject.toml`` or with custom naming, set the
 .. code-block:: bash
 
     export RIOT_PACKAGE_NAME=my-package
-    export RIOT_WHEEL_SOURCE=/tmp/wheels
+    export RIOT_WHEEL_PATH=/tmp/wheels
     riot run test
 
 
 How It Works
 ------------
 
-When a wheel source is specified:
+When a wheel path is specified:
 
 1. **Download**: riot downloads the wheel using ``pip download --no-index --find-links``
    to ensure only wheels from the specified source are used (not PyPI)
@@ -93,18 +93,18 @@ This ensures reproducibility and prevents accidental use of incorrect package ve
 Example: CI/CD Workflow
 -----------------------
 
-A typical CI/CD workflow using wheel sources:
+A typical CI/CD workflow using wheel paths:
 
 .. code-block:: bash
 
     # Step 1: Build wheels
     pip wheel --no-deps -w dist/ .
 
     # Step 2: Run tests with built wheels
-    riot --wheel-source dist/ run test
+    riot --wheel-path dist/ run test
 
     # Step 3: Verify wheels work in clean environments
-    riot --wheel-source dist/ generate --recreate-venvs
+    riot --wheel-path dist/ generate --recreate-venvs
 
 
 Example: Testing with Remote Wheels
@@ -115,9 +115,9 @@ Test against wheels published to a remote location:
 .. code-block:: bash
 
     # Test against wheels on an S3 bucket or web server
-    riot --wheel-source https://artifacts.example.com/wheels/v1.2.3/ run test
+    riot --wheel-path https://artifacts.example.com/wheels/v1.2.3/ run test
 
-The wheel source can be any location supported by pip's ``--find-links`` option,
+The wheel path can be any location supported by pip's ``--find-links`` option,
 including:
 
 - Local directories (``/path/to/wheels``)
@@ -133,13 +133,13 @@ Wheel sources work with all existing riot options:
 .. code-block:: bash
 
     # Recreate environments with wheels
-    riot --wheel-source /tmp/wheels run --recreate-venvs test
+    riot --wheel-path /tmp/wheels run --recreate-venvs test
 
     # Skip base install (wheels already installed)
-    riot --wheel-source /tmp/wheels run --skip-base-install test
+    riot --wheel-path /tmp/wheels run --skip-base-install test
 
     # Generate base environments with wheels
-    riot --wheel-source /tmp/wheels generate
+    riot --wheel-path /tmp/wheels generate
 
 
 Troubleshooting
@@ -170,7 +170,7 @@ Environment Variables Reference
 
    * - Variable
      - Description
-   * - ``RIOT_WHEEL_SOURCE``
+   * - ``RIOT_WHEEL_PATH``
      - Path or URL to wheel files. When set, installs from wheels instead of editable mode.
    * - ``RIOT_PACKAGE_NAME``
      - Package name to use when installing from wheels. Overrides automatic detection from ``pyproject.toml``.

releasenotes/notes/wheel-source-support-612999b83b5b0b9b.yaml

@@ -2,5 +2,5 @@
 features:
   - |
     Add support for installing from pre-built wheels instead of editable mode via the
-    ``--wheel-source`` global option and ``RIOT_WHEEL_SOURCE`` environment variable.
-    See https://ddriot.readthedocs.io/en/latest/wheel_sources.html for details.
+    ``--wheel-path`` global option and ``RIOT_WHEEL_PATH`` environment variable.
+    See https://riot.readthedocs.io/en/latest/wheel_sources.html for details.

riot/cli.py

@@ -79,16 +79,16 @@ def convert(self, value, param, ctx):
     help="Pipe mode. Makes riot emit plain output.",
 )
 @click.option(
-    "--wheel-source",
-    "wheel_source",
+    "--wheel-path",
+    "wheel_path",
     type=str,
     default=None,
-    envvar="RIOT_WHEEL_SOURCE",
+    envvar="RIOT_WHEEL_PATH",
     help="Path or URL to wheel files. When set, installs from wheels instead of editable mode.",
 )
 @click.version_option(__version__)
 @click.pass_context
-def main(ctx, riotfile, log_level, pipe_mode, wheel_source):
+def main(ctx, riotfile, log_level, pipe_mode, wheel_path):
     if pipe_mode:
         if log_level:
             logging.basicConfig(level=log_level)
@@ -102,7 +102,7 @@ def main(ctx, riotfile, log_level, pipe_mode, wheel_source):
 
     ctx.ensure_object(dict)
     ctx.obj["pipe"] = pipe_mode
-    ctx.obj["wheel_source"] = wheel_source
+    ctx.obj["wheel_path"] = wheel_path
 
     # Check if file exists first (before checking for subcommand)
     import os
@@ -177,13 +177,13 @@ def list_venvs(ctx, pythons, pattern, venv_pattern, interpreters, hash_only):
 @PATTERN_ARG
 @click.pass_context
 def generate(ctx, recreate_venvs, skip_base_install, pythons, pattern):
-    wheel_source = ctx.obj.get("wheel_source")
+    wheel_path = ctx.obj.get("wheel_path")
     ctx.obj["session"].generate_base_venvs(
         pattern=re.compile(pattern),
         recreate=recreate_venvs,
         skip_deps=skip_base_install,
         pythons=pythons,
-        wheel_source=wheel_source,
+        wheel_path=wheel_path,
     )
 
 
@@ -213,7 +213,7 @@ def run(
     venv_pattern,
     recompile_reqs,
 ):
-    wheel_source = ctx.obj.get("wheel_source")
+    wheel_path = ctx.obj.get("wheel_path")
     ctx.obj["session"].run(
         pattern=re.compile(pattern),
         venv_pattern=re.compile(venv_pattern),
@@ -225,7 +225,7 @@ def run(
         skip_missing=skip_missing,
         exit_first=exit_first,
         recompile_reqs=recompile_reqs,
-        wheel_source=wheel_source,
+        wheel_path=wheel_path,
     )
 
 
@@ -234,11 +234,11 @@ def run(
 @click.option("--pass-env", "pass_env", is_flag=True, default=False)
 @click.pass_context
 def shell(ctx, ident, pass_env):
-    wheel_source = ctx.obj.get("wheel_source")
+    wheel_path = ctx.obj.get("wheel_path")
     ctx.obj["session"].shell(
         ident=ident,
         pass_env=pass_env,
-        wheel_source=wheel_source,
+        wheel_path=wheel_path,
     )
 
 

riot/riot.py

@@ -578,7 +578,7 @@ def prepare(
         skip_deps: bool = False,
         recompile_reqs: bool = False,
         child_was_installed: bool = False,
-        wheel_source: t.Optional[str] = None,
+        wheel_path: t.Optional[str] = None,
     ) -> None:
         # Propagate the interpreter down the parenting relation
         self.py = py = py or self.py
@@ -602,7 +602,7 @@ def prepare(
             if self.created:
                 py.create_venv(recreate, venv_path)
                 if not self.venv.skip_dev_install or not skip_deps:
-                    install_dev_pkg(venv_path, force=True, wheel_source=wheel_source)
+                    install_dev_pkg(venv_path, force=True, wheel_path=wheel_path)
 
             pkg_str = self.pkg_str
             assert pkg_str is not None
@@ -641,7 +641,7 @@ def prepare(
                 env,
                 py,
                 child_was_installed=installed or exists or child_was_installed,
-                wheel_source=wheel_source,
+                wheel_path=wheel_path,
             )
 
 
@@ -724,7 +724,7 @@ def run(
         skip_missing: bool = False,
         exit_first: bool = False,
         recompile_reqs: bool = False,
-        wheel_source: t.Optional[str] = None,
+        wheel_path: t.Optional[str] = None,
     ) -> None:
         results = []
 
@@ -733,7 +733,7 @@ def run(
             recreate=recreate_venvs,
             skip_deps=skip_base_install,
             pythons=pythons,
-            wheel_source=wheel_source,
+            wheel_path=wheel_path,
         )
 
         for inst in self.venv.instances():
@@ -801,7 +801,7 @@ def run(
                 skip_deps=skip_base_install or inst.venv.skip_dev_install,
                 recreate=recreate_venvs,
                 recompile_reqs=recompile_reqs,
-                wheel_source=wheel_source,
+                wheel_path=wheel_path,
             )
 
             pythonpath = inst.pythonpath
@@ -967,7 +967,7 @@ def generate_base_venvs(
         recreate: bool,
         skip_deps: bool,
         pythons: t.Optional[t.Set[Interpreter]],
-        wheel_source: t.Optional[str] = None,
+        wheel_path: t.Optional[str] = None,
     ) -> None:
         """Generate all the required base venvs."""
         # Find all the python interpreters used.
@@ -1004,7 +1004,7 @@ def generate_base_venvs(
                     continue
 
                 # Install the dev package into the base venv.
-                install_dev_pkg(py.venv_path, force=True, wheel_source=wheel_source)
+                install_dev_pkg(py.venv_path, force=True, wheel_path=wheel_path)
 
     def _generate_shell_rcfile(self):
         with tempfile.NamedTemporaryFile() as rcfile:
@@ -1028,7 +1028,9 @@ def requirements(self, ident):
             with Status("Producing requirements.txt"):
                 _ = inst.requirements
 
-    def shell(self, ident: str, pass_env: bool, wheel_source: t.Optional[str] = None) -> None:
+    def shell(
+        self, ident: str, pass_env: bool, wheel_path: t.Optional[str] = None
+    ) -> None:
         for inst, venv_path in self._venvs_matching_identifier(ident):
             logger.info("Launching shell inside venv instance %s", inst)
             logger.debug("Setting venv path to %s", venv_path)
@@ -1043,7 +1045,7 @@ def shell(self, ident: str, pass_env: bool, wheel_source: t.Optional[str] = None
             # Should we expect the venv to be ready?
             with Status("Preparing shell virtual environment"):
                 inst.py.create_venv(False)
-                inst.prepare(env, wheel_source=wheel_source)
+                inst.prepare(env, wheel_path=wheel_path)
 
             pythonpath = inst.pythonpath
             if pythonpath:
@@ -1285,7 +1287,7 @@ def get_package_name() -> str:
 
 
 def install_dev_pkg(
-    venv_path: str, force: bool = False, wheel_source: t.Optional[str] = None
+    venv_path: str, force: bool = False, wheel_path: t.Optional[str] = None
 ) -> None:
     dev_pkg_lockfile = Path(venv_path) / ".riot-dev-pkg-installed"
     if dev_pkg_lockfile.exists() and not force:
@@ -1300,28 +1302,28 @@ def install_dev_pkg(
         return
 
     # Determine installation method
-    if wheel_source:
+    if wheel_path:
         # Install from wheels (two-step process to ensure we use only wheels from source)
         package_name = get_package_name()
         logger.info(
             "Installing dev package from wheels: %s (source: %s)",
             package_name,
-            wheel_source,
+            wheel_path,
         )
 
         # Step 1: Download wheel to temp directory using --no-index to avoid PyPI
         with tempfile.TemporaryDirectory() as tmp_dir:
             download_cmd = (
                 f"pip --disable-pip-version-check download "
-                f"--no-index --no-deps --find-links '{wheel_source}' "
+                f"--no-index --no-deps --find-links '{wheel_path}' "
                 f"--pre --dest '{tmp_dir}' '{package_name}'"
             )
             try:
                 Session.run_cmd_venv(venv_path, download_cmd, env=dict(os.environ))
             except CmdFailure as e:
                 logger.error(
                     "Wheel download failed. Ensure wheel exists at %s\n%s",
-                    wheel_source,
+                    wheel_path,
                     e.proc.stdout,
                 )
                 sys.exit(1)