reyk-cli 0.0.1__tar.gz

reyk_cli-0.0.1/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.3
+Name: reyk-cli
+Version: 0.0.1
+Summary: Manage isolated environment dependencies.
+Requires-Dist: typer>=0.20.0
+Requires-Dist: tomli>=2.4.0 ; python_full_version < '3.11'
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+

reyk_cli-0.0.1/pyproject.toml

@@ -0,0 +1,20 @@
+[project]
+name = "reyk-cli"
+version = "0.0.1"
+description = "Manage isolated environment dependencies."
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = ["typer>=0.20.0", "tomli>=2.4.0; python_version < '3.11'"]
+
+[dependency-groups]
+dev = ["pytest>=8.4.2", "tomli-w>=1.2.0"]
+
+[build-system]
+requires = ["uv_build>=0.8.3,<0.9.0"]
+build-backend = "uv_build"
+
+[project.scripts]
+reyk-cli = "reyk_cli.cli:app"
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]

reyk_cli-0.0.1/src/reyk_cli/cli.py

@@ -0,0 +1,79 @@
+from pathlib import Path
+from typing import Annotated, cast
+
+import typer
+
+from reyk_cli.configuration_reader import DEFAULT_VENDOR_GROUP, read_reyk_configuration
+from reyk_cli.uv_vendorizer import UVBasedVendorizer
+
+app = typer.Typer(
+    help="Manage isolated environment dependencies.",
+    no_args_is_help=True,
+)
+
+group_option = typer.Option(
+    default=DEFAULT_VENDOR_GROUP,
+    help="Dependency group to to vendor.",  # https://docs.astral.sh/uv/concepts/projects/dependencies/#dependency-groups
+)
+
+
+@app.callback()
+def main(
+    ctx: typer.Context,
+    config: Annotated[
+        Path,
+        typer.Option(
+            help="Where to find pyproject.toml containing vendored dependencies",
+            file_okay=True,
+            dir_okay=False,
+            exists=True,
+            readable=True,
+        ),
+    ] = Path("./pyproject.toml"),
+) -> None:
+    reyk_config = read_reyk_configuration(config)
+    ctx.obj = UVBasedVendorizer(
+        project_root=config.parent,
+        vendor_groups=reyk_config.vendor_groups,
+        libraries_target_path=Path(reyk_config.libraries_path),
+    )
+
+
+@app.command(help="Vendor the isolated environment dependencies.")
+def sync(ctx: typer.Context) -> None:
+    """Install the isolated environment dependencies."""
+    cast(UVBasedVendorizer, ctx.obj).sync_from_group_to_target_path()
+
+
+@app.command(
+    add_help_option=False,
+    # Allow any extra args to be passed to `uv`
+    context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
+)
+def add(
+    ctx: typer.Context,
+    group: str = group_option,
+) -> None:
+    """Add packages to the isolated environment."""
+    vendorizer = cast(UVBasedVendorizer, ctx.obj)
+    vendorizer.add_new_requirement_to_pyproject(group, ctx.args)
+    vendorizer.sync_from_group_to_target_path()
+
+
+@app.command(
+    add_help_option=False,
+    # Allow any extra args to be passed to `uv`
+    context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
+)
+def remove(
+    ctx: typer.Context,
+    group: str = group_option,
+) -> None:
+    """Remove packages from the isolated environment."""
+    vendorizer = cast(UVBasedVendorizer, ctx.obj)
+    vendorizer.remove_requirement_from_pyproject(group, ctx.args)
+    vendorizer.sync_from_group_to_target_path()
+
+
+if __name__ == "__main__":  # pragma: no cover
+    app()

reyk_cli-0.0.1/src/reyk_cli/command_executor.py

@@ -0,0 +1,13 @@
+import subprocess
+import logging
+import typer
+
+
+LOGGER = logging.getLogger(__name__)
+
+
+def run_command_exit_on_fail(cmd: list[str]) -> None:
+    result = subprocess.run(cmd, check=False)  # noqa: S603
+    LOGGER.debug(f"Executed {cmd=} -> {result.returncode=}")
+    if result.returncode != 0:
+        raise typer.Exit(result.returncode)

reyk_cli-0.0.1/src/reyk_cli/configuration_reader.py

@@ -0,0 +1,33 @@
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any, cast
+
+try:
+    import tomllib
+except ImportError:
+    import tomli as tomllib  # type: ignore[reportMissingImports]
+
+
+TOOLS_CONFIGURATION_NAME = "tool"
+REYK_CONFIGURATION_NAME = "reyk"
+
+DEFAULT_LIBRARIES_TARGET_PATH = "libs"  # Path the vendored libraries will be in
+DEFAULT_VENDOR_GROUP = "vendor-libs"
+DEFAULT_VENDOR_GROUPS = {DEFAULT_VENDOR_GROUP}
+
+
+@dataclass
+class ReykConfiguration:
+    libraries_path: str
+    vendor_groups: set[str]
+
+
+def read_reyk_configuration(toml_path: Path) -> ReykConfiguration:
+    toml_data = tomllib.loads(toml_path.read_text())
+    configuration = cast(
+        dict[str, Any],
+        toml_data.get(TOOLS_CONFIGURATION_NAME, {}).get(REYK_CONFIGURATION_NAME, {}),
+    )
+    configuration["libraries_path"] = configuration.pop("libraries-path", DEFAULT_LIBRARIES_TARGET_PATH)
+    configuration["vendor_groups"] = set(configuration.pop("vendor-groups", DEFAULT_VENDOR_GROUPS))
+    return ReykConfiguration(**configuration)

reyk_cli-0.0.1/src/reyk_cli/uv_vendorizer.py

@@ -0,0 +1,70 @@
+import itertools
+from collections.abc import Sequence
+from pathlib import Path
+
+import typer
+
+from reyk_cli.command_executor import run_command_exit_on_fail
+
+LOCK_FILE_NAME = "vendor.lock"
+
+
+class UVBasedVendorizer:
+    def __init__(self, project_root: Path, vendor_groups: set[str], libraries_target_path: Path) -> None:
+        self._project_root = project_root
+        self._vendor_groups = vendor_groups
+        self._libraries_target_path = libraries_target_path
+
+    def add_new_requirement_to_pyproject(self, vendor_group: str, command_args: Sequence[str]) -> None:
+        # The `uv add` command doesn't support installing to a custom target,
+        # so we use `--frozen` just to append the package to the `pyproject.toml`.
+        self._ensure_group_exists(vendor_group)
+        run_command_exit_on_fail(["uv", "add", "--frozen", "--group", vendor_group, *command_args])
+
+    def remove_requirement_from_pyproject(self, vendor_group: str, command_args: Sequence[str]) -> None:
+        # The `uv remove` command doesn't support installing to a custom target,
+        # so we use `--frozen` just to remove the package from the `pyproject.toml`.
+        self._ensure_group_exists(vendor_group)
+        run_command_exit_on_fail(["uv", "remove", "--frozen", "--group", vendor_group, *command_args])
+
+    def _ensure_group_exists(self, vendor_group: str) -> None:
+        if vendor_group not in self._vendor_groups:
+            raise typer.BadParameter(f"{vendor_group!s} not in {self._vendor_groups=}")
+
+    def sync_from_group_to_target_path(self) -> None:
+        # `uv pip sync` is the only command that supports installing to a custom target,
+        # but it requires a lock file. Therefore, we first export the lock file of the libs group
+        # and then use it to install the packages to the desired target.
+        self.create_lock_file_on_group()
+        self.install_requirements_from_lock_file()
+
+    def create_lock_file_on_group(self) -> None:
+        run_command_exit_on_fail(
+            [
+                "uv",
+                "export",
+                *itertools.chain.from_iterable([("--only-group", group) for group in self._vendor_groups]),
+                "--no-header",
+                "--quiet",
+                "--no-emit-project",
+                "--output-file",
+                str(self.lock_file_path),
+            ]
+        )
+
+    def install_requirements_from_lock_file(self) -> None:
+        run_command_exit_on_fail(
+            [
+                "uv",
+                "pip",
+                "sync",
+                str(self.lock_file_path),
+                "--target",
+                str(self._libraries_target_path),
+                "--allow-empty-requirements",
+            ]
+        )
+
+    @property
+    def lock_file_path(self) -> Path:
+        return self._project_root / LOCK_FILE_NAME