virtualshell 1.0.0__cp312-cp312-macosx_11_0_universal2.whl

virtualshell/__init__.py

@@ -0,0 +1,36 @@
+from __future__ import annotations
+from importlib import import_module
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .shell import ExecutionResult, Shell
+
+try:
+    from ._version import version as __version__
+except Exception:
+    __version__ = "0.1.2"
+
+
+from .errors import (
+    VirtualShellError,
+    PowerShellNotFoundError,
+    ExecutionTimeoutError,
+    ExecutionError,
+)
+
+__all__ = [
+    "VirtualShellError", "PowerShellNotFoundError",
+    "ExecutionTimeoutError", "ExecutionError",
+    "__version__", "Shell", "ExecutionResult",
+]
+
+def __getattr__(name: str):
+    if name in {"Shell", "ExecutionResult"}:
+        mod = import_module(".shell", __name__)
+        obj = getattr(mod, name)
+        globals()[name] = obj
+        return obj
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+def __dir__():
+    return sorted(__all__)

virtualshell/_version.py

@@ -0,0 +1 @@
+version = "0.1.2"

virtualshell/errors.py

@@ -0,0 +1,4 @@
+class VirtualShellError(RuntimeError): ...
+class PowerShellNotFoundError(VirtualShellError): ...
+class ExecutionTimeoutError(VirtualShellError): ...
+class ExecutionError(VirtualShellError): ...

virtualshell/shell.py

@@ -0,0 +1,515 @@
+"""
+High-level: Python façade over a C++ PowerShell runner (virtualshell_core).
+
+Design goals (production-readiness):
+- **Thin wrapper**: All heavy I/O and process orchestration live in C++ for performance.
+- **No surprises**: Stable API; no implicit state mutations beyond what is documented.
+- **Clear failure modes**: Dedicated exceptions and `raise_on_error` semantics.
+- **Thread-friendly**: Async methods return Futures and accept callbacks; no Python-side locks.
+- **Boundary hygiene**: Minimal data marshalling; explicit conversions for paths/args.
+
+Security notes:
+- This wrapper does not sanitize commands. Only `pwsh()` uses literal quoting via `quote_pwsh_literal()`.
+- Do *not* pass untrusted strings to `execute*` unless you quote/sanitize appropriately.
+- Environment injection occurs via Config; avoid leaking secrets in logs/tracebacks.
+
+Perf notes:
+- All sync/async execution routes call into C++ directly. Python overhead is dominated by
+  object creation and callback dispatch. Keep callbacks lean.
+- Prefer batch/async when issuing many small commands to amortize round-trips.
+
+Lifetime:
+- `Shell.start()` ensures there is a running backend process. `Shell.stop()` tears it down.
+- Context manager (`with Shell(...) as sh:`) guarantees stop-on-exit.
+
+Compatibility:
+- The C++ layer may expose both snake_case and camelCase fields; `ExecutionResult.from_cpp()`
+  maps both to keep ABI compatibility.
+"""
+from __future__ import annotations
+
+import importlib
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Iterable, List, Dict, Optional, Callable, Any, Union
+import concurrent.futures as cf
+
+
+_CPP_MODULE: Any = None
+
+import importlib
+try:
+    _CPP_MODULE = importlib.import_module(f"{__package__}._core")
+except Exception as e:
+    raise ImportError(
+        "Failed to import the compiled extension 'virtualshell._core'. "
+        "Make sure it was built and matches this Python/platform."
+    ) from e
+
+
+# Aliases to reduce attribute lookups on the hot path.
+_CPP_VirtualShell = _CPP_MODULE.VirtualShell
+_CPP_Config       = _CPP_MODULE.Config
+_CPP_ExecResult   = _CPP_MODULE.ExecutionResult
+_CPP_BatchProg    = _CPP_MODULE.BatchProgress
+
+
+# ---------- Exceptions ----------
+# Narrow, typed exceptions help callers implement precise retry/telemetry policies.
+from .errors import (
+    VirtualShellError,
+    PowerShellNotFoundError,
+    ExecutionTimeoutError,
+    ExecutionError,
+)
+
+# ---------- Utils ----------
+def quote_pwsh_literal(s: str) -> str:
+    """Return a PowerShell *single-quoted* literal for arbitrary text `s`.
+
+    Rules:
+    - Empty string => `''` (empty single-quoted literal)
+    - Single quotes are doubled inside the literal per PowerShell rules.
+    - No interpolation/expansion occurs within single quotes in PowerShell.
+
+    This is safe for *data-as-argument* scenarios, not for embedding raw code.
+    Use it to construct commands like: `Write-Output {literal}`.
+    """
+    if not s:
+        return "''"
+    out: List[str] = []
+    append = out.append
+    append("'")
+    for ch in s:
+        append("''" if ch == "'" else ch)
+    append("'")
+    return "".join(out)
+
+def _effective_timeout(user_timeout: Optional[float], default_seconds: float) -> float:
+    """Resolve an effective timeout (seconds).
+
+    Priority:
+    1) `user_timeout` if provided and > 0
+    2) C++ config default (`default_seconds`)
+
+    Always returns a float >= 0.0.
+    """
+    return float(user_timeout) if (user_timeout and user_timeout > 0) else float(default_seconds or 0.0)
+
+
+def _raise_on_failure(
+    res: _CPP_ExecResult,
+    *,
+    raise_on_error: bool,
+    label: str,
+    timeout_used: Optional[float],
+) -> None:
+    """Translate a C++ result into Python exceptions when requested.
+
+    - If `res.success` is True: no-op.
+    - Timeout heuristic: if `exit_code == -1` and the error string mentions "timeout",
+      raise `ExecutionTimeoutError` with the effective timeout used.
+    - Otherwise, if `raise_on_error` is True, raise `ExecutionError` with details.
+
+    This keeps the default behavior non-throwing for bulk workflows while allowing
+    strict error handling in critical paths.
+    """
+    if res.success:
+        return
+    err = (res.error or "")
+    if res.exit_code == -1 and "timeout" in err.lower():
+        raise ExecutionTimeoutError(f"{label} timed out after {timeout_used}s")
+    if raise_on_error:
+        msg = err if err else f"{label} failed with exit_code={res.exit_code}"
+        raise ExecutionError(msg)
+
+
+def _map_future(src_fut: cf.Future, mapper: Callable[[Any], Any]) -> cf.Future:
+    """Create a new Future that maps the result of `src_fut` through `mapper`.
+
+    - Preserves exception semantics: exceptions from `src_fut` or the mapper
+      are propagated to the mapped future.
+    - Avoids blocking the event loop / thread: uses `add_done_callback`.
+    """
+    nfut: cf.Future = cf.Future()
+
+    def _done(f: cf.Future) -> None:
+        try:
+            nfut.set_result(mapper(f.result()))
+        except Exception as e:  # Propagate mapping errors
+            nfut.set_exception(e)
+
+    src_fut.add_done_callback(_done)
+    return nfut
+
+
+# ---------- Python façade ----------
+@dataclass(frozen=True)
+class ExecutionResult:
+    """Immutable Python-side execution result for ergonomic access.
+
+    Mirrors fields from the C++ `ExecutionResult` (snake_case/camelCase tolerant):
+    - output:      Captured STDOUT
+    - error:       Captured STDERR or synthesized error text
+    - exit_code:   Process/command exit code (convention: -1 often signals timeout)
+    - success:     Normalized success flag provided by the backend
+    - execution_time: Seconds (float) measured by the backend
+
+    Use this class when you need a stable Pythonic type. If you require the raw C++
+    object (e.g., for zero-copy interop), pass `as_dataclass=False` to public APIs.
+    """
+    out: str
+    err: str
+    exit_code: int
+    success: bool
+    execution_time: float
+
+    @classmethod
+    def from_cpp(cls, r: _CPP_ExecResult) -> "ExecutionResult":
+        # Attribute access is defensive to tolerate ABI field name differences.
+        return cls(
+            out=getattr(r, "output", ""),
+            err=getattr(r, "error", ""),
+            exit_code=int(getattr(r, "exit_code", getattr(r, "exitCode", -1))),
+            success=bool(getattr(r, "success", False)),
+            execution_time=float(getattr(r, "execution_time", getattr(r, "executionTime", 0.0))),
+        )
+
+
+# ---------- Public API ----------
+class Shell:
+    """Thin ergonomic wrapper around the C++ VirtualShell.
+
+    Notes:
+    - No Python-side I/O; all execution flows delegate to the C++ backend.
+    - All timeouts are best-effort and enforced by the backend. A timeout typically
+      returns `exit_code == -1` and `success == False` with an error message.
+    - Methods that accept `as_dataclass` can return the raw C++ result for callers
+      that want to avoid extra allocations/mapping.
+    """
+
+    def __init__(
+        self,
+        powershell_path: Optional[str] = None,
+        working_directory: Optional[Union[str, Path]] = None,
+        timeout_seconds: float = 5.0,
+        environment: Optional[Dict[str, str]] = None,
+        initial_commands: Optional[List[str]] = None,
+        cpp_module: Any = None,
+    ) -> None:
+        """Configure a new Shell instance.
+
+        Parameters
+        ----------
+        powershell_path : Optional[str]
+            Explicit path to `pwsh`/`powershell`. If omitted, the backend resolves it.
+        working_directory : Optional[Union[str, Path]]
+            Working directory for the child process. Resolved to an absolute path.
+        timeout_seconds : float
+            Default per-command timeout used when a method's `timeout` is not provided.
+        environment : Optional[Dict[str, str]]
+            Extra environment variables for the child process.
+        initial_commands : Optional[List[str]]
+            Commands that the backend will issue on process start (e.g., encoding setup).
+        cpp_module : Any
+            For testing/DI: provide a custom module exposing the C++ API surface.
+        """
+        mod = cpp_module or _CPP_MODULE
+        cfg = mod.Config()
+        if powershell_path:
+            cfg.powershell_path = str(powershell_path)
+        if working_directory:
+            cfg.working_directory = str(Path(working_directory).resolve())
+        cfg.timeout_seconds = int(timeout_seconds or 0)
+
+        if environment:
+            # Copy to detach from caller's dict and avoid accidental mutation.
+            cfg.environment = dict(environment)
+        if initial_commands:
+            # Force string-ification to prevent surprises from non-str types.
+            cfg.initial_commands = list(map(str, initial_commands))
+
+        self._cfg: _CPP_Config = cfg
+        self._core: _CPP_VirtualShell = mod.VirtualShell(cfg)
+
+    def start(self) -> "Shell":
+        """Start (or confirm) the backend PowerShell process.
+
+        Returns self for fluent chaining.
+        Raises `PowerShellNotFoundError` if the process cannot be started.
+        """
+        if self._core.is_alive():
+            return self
+        if self._core.start():
+            return self
+
+        # Backend could not start the process; provide a precise error.
+        raise PowerShellNotFoundError(
+            f"Failed to start PowerShell process. Path: '{self._cfg.powershell_path or 'pwsh/powershell'}'"
+        )
+
+    def stop(self, force: bool = False) -> None:
+        """Stop the backend process.
+
+        `force=True` requests an immediate termination (backend-specific semantics).
+        Always safe to call; errors are wrapped in `SmartShellError`.
+        """
+        try:
+            self._core.stop(force)
+        except Exception as e:  # Surface backend failures in a consistent type.
+            raise VirtualShellError(f"Failed to stop PowerShell: {e}") from e
+
+    @property
+    def is_running(self) -> bool:
+        """Return True if the backend process is alive."""
+        return bool(self._core.is_alive())
+
+    # -------- sync --------
+    def run(
+        self,
+        command: str,
+        timeout: Optional[float] = None,
+        *,
+        raise_on_error: bool = False,
+        as_dataclass: bool = True,
+    ) -> Union[ExecutionResult, _CPP_ExecResult]:
+        """Execute a single PowerShell command string.
+
+        Parameters
+        ----------
+        command : str
+            Raw PowerShell command. Caller is responsible for quoting/sanitizing.
+        timeout : Optional[float]
+            Per-call timeout override in seconds; <= 0 means "no override".
+        raise_on_error : bool
+            If True, raise `ExecutionTimeoutError`/`ExecutionError` on failure.
+        as_dataclass : bool
+            If True, return an `ExecutionResult`; otherwise return the raw C++ result.
+        """
+        to = _effective_timeout(timeout, self._cfg.timeout_seconds)
+        res: _CPP_ExecResult = self._core.execute(command=command, timeout_seconds=to)
+        _raise_on_failure(res, raise_on_error=raise_on_error, label="Command", timeout_used=to)
+        return ExecutionResult.from_cpp(res) if as_dataclass else res
+
+    def run_script(
+        self,
+        script_path: Union[str, Path],
+        args: Optional[Iterable[str]] = None,
+        timeout: Optional[float] = None,
+        *,
+        dot_source: bool = False,
+        raise_on_error: bool = False,
+        as_dataclass: bool = True,
+    ) -> Union[ExecutionResult, _CPP_ExecResult]:
+        """Execute a script file with positional arguments.
+
+        - `args` are passed as-is to the backend; quote appropriately for your script.
+        - `dot_source=True` runs in the current context (if supported by the backend),
+          which can mutate session state. Use with care.
+        - `raise_on_error` only affects Python-side exception raising; the backend
+          always runs with `raise_on_error=False` to avoid double-throwing.
+        """
+        to = _effective_timeout(timeout, self._cfg.timeout_seconds)
+        res: _CPP_ExecResult = self._core.execute_script(
+            script_path=str(Path(script_path).resolve()),
+            args=list(args or []),
+            timeout_seconds=to,
+            dot_source=bool(dot_source),
+            raise_on_error=False,
+        )
+        _raise_on_failure(res, raise_on_error=raise_on_error, label="Script", timeout_used=to)
+        return ExecutionResult.from_cpp(res) if as_dataclass else res
+
+    def run_script_kv(
+        self,
+        script_path: Union[str, Path],
+        named_args: Optional[Dict[str, str]] = None,
+        timeout: Optional[float] = None,
+        *,
+        dot_source: bool = False,
+        raise_on_error: bool = False,
+        as_dataclass: bool = True,
+    ) -> Union[ExecutionResult, _CPP_ExecResult]:
+        """Execute a script file with *named* arguments.
+
+        `named_args` is copied to detach from caller mutations. Keys/values must be
+        strings representable in the PowerShell context (caller ensures quoting).
+        """
+        to = _effective_timeout(timeout, self._cfg.timeout_seconds)
+        res: _CPP_ExecResult = self._core.execute_script_kv(
+            script_path=str(Path(script_path).resolve()),
+            named_args=dict(named_args or {}),
+            timeout_seconds=to,
+            dot_source=bool(dot_source),
+            raise_on_error=False,
+        )
+        _raise_on_failure(res, raise_on_error=raise_on_error, label="ScriptKV", timeout_used=to)
+        return ExecutionResult.from_cpp(res) if as_dataclass else res
+
+    def run_batch(
+        self,
+        commands: Iterable[str],
+        *,
+        per_command_timeout: Optional[float] = None,
+        stop_on_first_error: bool = True,
+        as_dataclass: bool = True,
+    ) -> List[Union[ExecutionResult, _CPP_ExecResult]]:
+        """Execute multiple commands sequentially in the same session.
+
+        - `per_command_timeout` applies to each individual command.
+        - `stop_on_first_error` semantics are enforced by the backend.
+        - Returns a list of results preserving the order of input commands.
+        """
+        to = _effective_timeout(per_command_timeout, self._cfg.timeout_seconds)
+        vec = self._core.execute_batch(
+            commands=list(commands),
+            timeout_seconds=to,
+        )
+        if as_dataclass:
+            return [ExecutionResult.from_cpp(r) for r in vec]
+        return vec
+
+    def run_async(self, command: str, callback: Optional[Callable[[ExecutionResult], None]] = None, *, as_dataclass: bool = True):
+        """Asynchronously execute a single command.
+
+        - If `callback` is provided, it is invoked on completion with the result type
+          controlled by `as_dataclass`.
+        - Returns a `concurrent.futures.Future` from the backend; if `as_dataclass` is True,
+          the returned future is a mapped proxy that yields `ExecutionResult`.
+        - Exceptions in your callback are swallowed to avoid breaking the executor.
+        """
+        def _cb(py_res: _CPP_ExecResult) -> None:
+            if callback is None:
+                return
+            try:
+                callback(ExecutionResult.from_cpp(py_res) if as_dataclass else py_res)
+            except Exception:
+                # Intentionally ignore to keep the executor stable.
+                pass
+
+        c_fut = self._core.execute_async(command=command, callback=_cb if callback else None)
+        return _map_future(c_fut, lambda r: ExecutionResult.from_cpp(r)) if as_dataclass else c_fut
+
+    def run_async_batch(
+        self,
+        commands: Iterable[str],
+        progress: Optional[Callable[[ _CPP_BatchProg ], None]] = None,
+        *,
+        per_command_timeout: Optional[float] = None,
+        stop_on_first_error: bool = True,
+        as_dataclass: bool = True,
+    ):
+        """Asynchronously execute a batch of commands.
+
+        - `progress` is a pass-through callback from the backend for per-command updates.
+        - Returns a Future resolving to a list of results. Mapping to `ExecutionResult`
+          is applied if `as_dataclass` is True.
+        """
+        to = _effective_timeout(per_command_timeout, self._cfg.timeout_seconds)
+        fut = self._core.execute_async_batch(
+            commands=list(commands),
+            progress_callback=progress if progress else None,
+            stop_on_first_error=bool(stop_on_first_error),
+            per_command_timeout_seconds=to,
+        )
+        if as_dataclass:
+            return _map_future(fut, lambda vec: [ExecutionResult.from_cpp(r) for r in vec])
+        return fut
+
+    def run_async_script(
+        self,
+        script_path: Union[str, Path],
+        args: Optional[Iterable[str]] = None,
+        callback: Optional[Callable[[ExecutionResult], None]] = None,
+        *,
+        timeout: Optional[float] = None,
+        dot_source: bool = False,
+        as_dataclass: bool = True,
+    ):
+        """Asynchronously execute a script with positional args.
+
+        - `callback` is invoked (if provided) upon completion. Exceptions inside
+          the callback are suppressed to protect the executor.
+        - Returns a Future that yields either the raw C++ result or `ExecutionResult`.
+        """
+        def _cb(py_res: _CPP_ExecResult) -> None:
+            if callback is None:
+                return
+            try:
+                callback(ExecutionResult.from_cpp(py_res) if as_dataclass else py_res)
+            except Exception:
+                pass
+
+        to = _effective_timeout(timeout, self._cfg.timeout_seconds)
+        fut = self._core.execute_async_script(
+            script_path=str(Path(script_path).resolve()),
+            args=list(args or []),
+            callback=_cb if callback else None,
+            timeout_seconds=to,
+            dot_source=bool(dot_source),
+            raise_on_error=False,
+        )
+        if as_dataclass:
+            return _map_future(fut, lambda r: ExecutionResult.from_cpp(r))
+        return fut
+
+    def run_async_script_kv(
+        self,
+        script_path: Union[str, Path],
+        named_args: Optional[Dict[str, str]] = None,
+        callback: Optional[Callable[[ExecutionResult], None]] = None,
+        *,
+        timeout: Optional[float] = None,
+        dot_source: bool = False,
+        as_dataclass: bool = True,
+    ):
+        """Asynchronously execute a script with named args.
+
+        If `callback` is provided, it is wired to the returned Future using
+        `add_done_callback` and receives the mapped result when available.
+        """
+        to = _effective_timeout(timeout, self._cfg.timeout_seconds)
+        fut = self._core.execute_async_script_kv(
+            script_path=str(Path(script_path).resolve()),
+            named_args=dict(named_args or {}),
+            timeout_seconds=to,
+            dot_source=bool(dot_source),
+            raise_on_error=False,
+        )
+        if callback:
+            def _done(f: cf.Future) -> None:
+                try:
+                    py_res = f.result()
+                    callback(ExecutionResult.from_cpp(py_res) if as_dataclass else py_res)
+                except Exception:
+                    # Suppress to avoid breaking the executor.
+                    pass
+            try:
+                fut.add_done_callback(_done)
+            except Exception:
+                # If the backend future doesn't support callbacks, silently continue.
+                pass
+        if as_dataclass:
+            return _map_future(fut, lambda r: ExecutionResult.from_cpp(r))
+        return fut
+
+    # -------- convenience --------
+    def pwsh(self, s: str, timeout: Optional[float] = None, raise_on_error: bool = False) -> ExecutionResult:
+        """Execute a **literal** PowerShell string safely.
+
+        Example:
+            `shell.pwsh("Hello 'World'")` -> runs `Write-Output 'Hello ''World'''` semantics;
+            here we only quote the literal; you still provide the full command.
+        """
+        return self.run(quote_pwsh_literal(s), timeout=timeout, raise_on_error=raise_on_error)
+
+    def __enter__(self) -> "Shell":
+        """Context manager entry: ensure backend is running."""
+        if not self._core.is_alive():
+            self.start()
+        return self
+
+    def __exit__(self, exc_type, exc, tb) -> None:
+        """Context manager exit: stop backend regardless of errors in the block."""
+        self.stop()
+        return None

virtualshell-1.0.0.dist-info/METADATA

@@ -0,0 +1,461 @@
+Metadata-Version: 2.2
+Name: virtualshell
+Version: 1.0.0
+Summary: High-performance PowerShell bridge (C++ pybind11 backend)
+Keywords: powershell,automation,shell,cpp,pybind11
+Author: Kim-Andre Myrvold
+License:                                  Apache License
+                                    Version 2.0, January 2004
+                                 http://www.apache.org/licenses/
+         
+            TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+         
+            1. Definitions.
+         
+               "License" shall mean the terms and conditions for use, reproduction,
+               and distribution as defined by Sections 1 through 9 of this document.
+         
+               "Licensor" shall mean the copyright owner or entity authorized by
+               the copyright owner that is granting the License.
+         
+               "Legal Entity" shall mean the union of the acting entity and all
+               other entities that control, are controlled by, or are under common
+               control with that entity. For the purposes of this definition,
+               "control" means (i) the power, direct or indirect, to cause the
+               direction or management of such entity, whether by contract or
+               otherwise, or (ii) ownership of fifty percent (50%) or more of the
+               outstanding shares, or (iii) beneficial ownership of such entity.
+         
+               "You" (or "Your") shall mean an individual or Legal Entity
+               exercising permissions granted by this License.
+         
+               "Source" form shall mean the preferred form for making modifications,
+               including but not limited to software source code, documentation
+               source, and configuration files.
+         
+               "Object" form shall mean any form resulting from mechanical
+               transformation or translation of a Source form, including but
+               not limited to compiled object code, generated documentation,
+               and conversions to other media types.
+         
+               "Work" shall mean the work of authorship, whether in Source or
+               Object form, made available under the License, as indicated by a
+               copyright notice that is included in or attached to the work
+               (an example is provided in the Appendix below).
+         
+               "Derivative Works" shall mean any work, whether in Source or Object
+               form, that is based on (or derived from) the Work and for which the
+               editorial revisions, annotations, elaborations, or other modifications
+               represent, as a whole, an original work of authorship. For the purposes
+               of this License, Derivative Works shall not include works that remain
+               separable from, or merely link (or bind by name) to the interfaces of,
+               the Work and Derivative Works thereof.
+         
+               "Contribution" shall mean any work of authorship, including
+               the original version of the Work and any modifications or additions
+               to that Work or Derivative Works thereof, that is intentionally
+               submitted to Licensor for inclusion in the Work by the copyright owner
+               or by an individual or Legal Entity authorized to submit on behalf of
+               the copyright owner. For the purposes of this definition, "submitted"
+               means any form of electronic, verbal, or written communication sent
+               to the Licensor or its representatives, including but not limited to
+               communication on electronic mailing lists, source code control systems,
+               and issue tracking systems that are managed by, or on behalf of, the
+               Licensor for the purpose of discussing and improving the Work, but
+               excluding communication that is conspicuously marked or otherwise
+               designated in writing by the copyright owner as "Not a Contribution."
+         
+               "Contributor" shall mean Licensor and any individual or Legal Entity
+               on behalf of whom a Contribution has been received by Licensor and
+               subsequently incorporated within the Work.
+         
+            2. Grant of Copyright License. Subject to the terms and conditions of
+               this License, each Contributor hereby grants to You a perpetual,
+               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+               copyright license to reproduce, prepare Derivative Works of,
+               publicly display, publicly perform, sublicense, and distribute the
+               Work and such Derivative Works in Source or Object form.
+         
+            3. Grant of Patent License. Subject to the terms and conditions of
+               this License, each Contributor hereby grants to You a perpetual,
+               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+               (except as stated in this section) patent license to make, have made,
+               use, offer to sell, sell, import, and otherwise transfer the Work,
+               where such license applies only to those patent claims licensable
+               by such Contributor that are necessarily infringed by their
+               Contribution(s) alone or by combination of their Contribution(s)
+               with the Work to which such Contribution(s) was submitted. If You
+               institute patent litigation against any entity (including a
+               cross-claim or counterclaim in a lawsuit) alleging that the Work
+               or a Contribution incorporated within the Work constitutes direct
+               or contributory patent infringement, then any patent licenses
+               granted to You under this License for that Work shall terminate
+               as of the date such litigation is filed.
+         
+            4. Redistribution. You may reproduce and distribute copies of the
+               Work or Derivative Works thereof in any medium, with or without
+               modifications, and in Source or Object form, provided that You
+               meet the following conditions:
+         
+               (a) You must give any other recipients of the Work or
+                   Derivative Works a copy of this License; and
+         
+               (b) You must cause any modified files to carry prominent notices
+                   stating that You changed the files; and
+         
+               (c) You must retain, in the Source form of any Derivative Works
+                   that You distribute, all copyright, patent, trademark, and
+                   attribution notices from the Source form of the Work,
+                   excluding those notices that do not pertain to any part of
+                   the Derivative Works; and
+         
+               (d) If the Work includes a "NOTICE" text file as part of its
+                   distribution, then any Derivative Works that You distribute must
+                   include a readable copy of the attribution notices contained
+                   within such NOTICE file, excluding those notices that do not
+                   pertain to any part of the Derivative Works, in at least one
+                   of the following places: within a NOTICE text file distributed
+                   as part of the Derivative Works; within the Source form or
+                   documentation, if provided along with the Derivative Works; or,
+                   within a display generated by the Derivative Works, if and
+                   wherever such third-party notices normally appear. The contents
+                   of the NOTICE file are for informational purposes only and
+                   do not modify the License. You may add Your own attribution
+                   notices within Derivative Works that You distribute, alongside
+                   or as an addendum to the NOTICE text from the Work, provided
+                   that such additional attribution notices cannot be construed
+                   as modifying the License.
+         
+               You may add Your own copyright statement to Your modifications and
+               may provide additional or different license terms and conditions
+               for use, reproduction, or distribution of Your modifications, or
+               for any such Derivative Works as a whole, provided Your use,
+               reproduction, and distribution of the Work otherwise complies with
+               the conditions stated in this License.
+         
+            5. Submission of Contributions. Unless You explicitly state otherwise,
+               any Contribution intentionally submitted for inclusion in the Work
+               by You to the Licensor shall be under the terms and conditions of
+               this License, without any additional terms or conditions.
+               Notwithstanding the above, nothing herein shall supersede or modify
+               the terms of any separate license agreement you may have executed
+               with Licensor regarding such Contributions.
+         
+            6. Trademarks. This License does not grant permission to use the trade
+               names, trademarks, service marks, or product names of the Licensor,
+               except as required for reasonable and customary use in describing the
+               origin of the Work and reproducing the content of the NOTICE file.
+         
+            7. Disclaimer of Warranty. Unless required by applicable law or
+               agreed to in writing, Licensor provides the Work (and each
+               Contributor provides its Contributions) on an "AS IS" BASIS,
+               WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+               implied, including, without limitation, any warranties or conditions
+               of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+               PARTICULAR PURPOSE. You are solely responsible for determining the
+               appropriateness of using or redistributing the Work and assume any
+               risks associated with Your exercise of permissions under this License.
+         
+            8. Limitation of Liability. In no event and under no legal theory,
+               whether in tort (including negligence), contract, or otherwise,
+               unless required by applicable law (such as deliberate and grossly
+               negligent acts) or agreed to in writing, shall any Contributor be
+               liable to You for damages, including any direct, indirect, special,
+               incidental, or consequential damages of any character arising as a
+               result of this License or out of the use or inability to use the
+               Work (including but not limited to damages for loss of goodwill,
+               work stoppage, computer failure or malfunction, or any and all
+               other commercial damages or losses), even if such Contributor
+               has been advised of the possibility of such damages.
+         
+            9. Accepting Warranty or Additional Liability. While redistributing
+               the Work or Derivative Works thereof, You may choose to offer,
+               and charge a fee for, acceptance of support, warranty, indemnity,
+               or other liability obligations and/or rights consistent with this
+               License. However, in accepting such obligations, You may act only
+               on Your own behalf and on Your sole responsibility, not on behalf
+               of any other Contributor, and only if You agree to indemnify,
+               defend, and hold each Contributor harmless for any liability
+               incurred by, or claims asserted against, such Contributor by reason
+               of your accepting any such warranty or additional liability.
+         
+            END OF TERMS AND CONDITIONS
+         
+            APPENDIX: How to apply the Apache License to your work.
+         
+               To apply the Apache License to your work, attach the following
+               boilerplate notice, with the fields enclosed by brackets "[]"
+               replaced with your own identifying information. (Don't include
+               the brackets!)  The text should be enclosed in the appropriate
+               comment syntax for the file format. We also recommend that a
+               file or class name and description of purpose be included on the
+               same "printed page" as the copyright notice for easier
+               identification within third-party archives.
+         
+            Copyright 2025 Kim-Andre Myrvold
+         
+            Licensed under the Apache License, Version 2.0 (the "License");
+            you may not use this file except in compliance with the License.
+            You may obtain a copy of the License at
+         
+                http://www.apache.org/licenses/LICENSE-2.0
+         
+            Unless required by applicable law or agreed to in writing, software
+            distributed under the License is distributed on an "AS IS" BASIS,
+            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+            See the License for the specific language governing permissions and
+            limitations under the License.
+         
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: C++
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: License :: OSI Approved :: MIT License
+Project-URL: Homepage, https://github.com/Chamoswor/virtualshell
+Project-URL: Issues, https://github.com/Chamoswor/virtualshell/issues
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+````markdown
+# virtualshell
+
+High-performance Python façade over a **C++ PowerShell runner**.  
+A single long-lived PowerShell process is managed in C++, handling pipes, threads, timeouts and output demux; Python exposes a small, predictable API.
+
+---
+
+## Features
+
+- **Persistent session** to `pwsh`/`powershell` (reuse modules, `$env:*`, functions, cwd)
+- **Sync & async** execution (Futures + optional callbacks)
+- **Script execution** (positional / named args, optional dot-sourcing)
+- **Batch** with per-command timeout & early-stop
+- **Clear failures** (typed exceptions), **context manager** lifecycle
+
+---
+
+## Install
+
+```bash
+pip install virtualshell
+````
+
+### Supported platforms
+
+* **Windows 10/11 x64**
+* **Linux**: x86_64 and aarch64 (manylinux_2_28 / glibc ≥ 2.28)
+* **macOS**: 12+ (x86_64 and arm64)
+* **Python**: 3.8 – 3.13
+
+> Requires PowerShell on `PATH` (`pwsh` preferred, `powershell` also supported).
+
+---
+
+## Quick start
+
+```python
+import virtualshell
+
+# Create a shell with a 5s default timeout
+sh = virtualshell.Shell(timeout_seconds=5).start()
+
+# 1) One-liners (sync)
+res = sh.run("Write-Output 'hello'")
+print(res.out.strip())  # -> hello
+
+# 2) Async single command
+fut = sh.run_async("Write-Output 'async!'")
+print(fut.result().out.strip())
+
+# 3) Scripts with positional args
+r = sh.run_script(r"C:\temp\demo.ps1", args=["alpha", "42"])
+print(r.out)
+
+# 4) Scripts with named args
+r = sh.run_script_kv(r"C:\temp\demo.ps1", named_args={"Name":"Alice","Count":"3"})
+print(r.out)
+
+# 5) Context manager (auto-stop on exit)
+with virtualshell.Shell(timeout_seconds=3) as s:
+    print(s.run("Write-Output 'inside with'").out.strip())
+
+sh.stop()
+```
+
+Another example (stateful session):
+
+```python
+from virtualshell import Shell
+with Shell(timeout_seconds=3) as sh:
+    sh.run("function Inc { $global:i++; $global:i }")
+    nums = [sh.run("Inc").out.strip() for _ in range(5)]
+    print(nums)  # ['1','2','3','4','5']
+```
+
+---
+
+## API (overview)
+
+```python
+import virtualshell
+from virtualshell import ExecutionResult  # dataclass view
+
+sh = virtualshell.Shell(
+    powershell_path=None,                     # optional explicit path
+    working_directory=None,                   # resolved to absolute path
+    timeout_seconds=5.0,                      # default per-command timeout
+    environment={"FOO": "BAR"},               # extra child env vars
+    initial_commands=["$ErrorActionPreference='Stop'"],  # post-start setup
+).start()
+
+# Sync
+res: ExecutionResult = sh.run("Get-Location | Select-Object -Expand Path")
+
+# Scripts
+res = sh.run_script(r"/path/to/job.ps1", args=["--fast","1"])
+res = sh.run_script_kv(r"/path/to/job.ps1", named_args={"Mode":"Fast","Count":"1"})
+res = sh.run_script(r"/path/init.ps1", dot_source=True)
+
+# Async
+f = sh.run_async("Write-Output 'ping'")
+f2 = sh.run_async_batch(["$PSVersionTable", "Get-Random"])
+
+# Convenience
+res = sh.pwsh("literal 'quoted' string")     # safe single-quoted literal
+
+sh.stop()
+```
+
+### Return type
+
+By default you get a Python dataclass:
+
+```python
+@dataclass(frozen=True)
+class ExecutionResult:
+    output: str
+    error: str
+    exit_code: int
+    success: bool
+    execution_time: float
+```
+
+Pass `as_dataclass=False` to receive the raw C++ result object.
+
+### Timeouts
+
+* Every method accepts a `timeout` (or `per_command_timeout`) in seconds.
+* On timeout: `success=False`, `exit_code=-1`, `error` contains `"timeout"`.
+* Async futures resolve with the timeout result; late output is dropped in C++.
+
+---
+
+## Design notes
+
+* **Thin wrapper:** heavy I/O in C++; Python does orchestration only.
+* **No surprises:** stable API, documented side-effects.
+* **Clear failure modes:** `raise_on_error` and typed exceptions.
+* **Thread-friendly:** async returns Futures/callbacks; no Python GIL-level locking.
+* **Boundary hygiene:** explicit path/arg conversions, minimal marshalling.
+
+### Security
+
+* The wrapper **does not sanitize** raw commands. Only `pwsh()` applies literal single-quoting for data.
+* Don’t pass untrusted strings to `run*` without proper quoting/sanitization.
+* Avoid logging secrets; env injection happens via `Shell(..., environment=...)`.
+
+### Performance
+
+* Sync/async routes call into C++ directly; Python overhead is object creation + callback dispatch.
+* Prefer **batch/async** for many small commands to amortize round-trips.
+
+### Lifetime
+
+* `Shell.start()` ensures a running backend; `Shell.stop()` tears it down.
+* `with Shell(...)` guarantees stop-on-exit, even on exceptions.
+
+---
+
+## Exceptions
+
+```python
+from virtualshell.errors import (
+    VirtualShellError,
+    PowerShellNotFoundError,
+    ExecutionTimeoutError,
+    ExecutionError,
+)
+
+try:
+    res = sh.run("throw 'boom'", raise_on_error=True)
+except ExecutionTimeoutError:
+    ...
+except ExecutionError as e:
+    print("PowerShell failed:", e)
+```
+
+* `ExecutionTimeoutError` is raised on timeouts **if** `raise_on_error=True`.
+* Otherwise, APIs return `ExecutionResult(success=False)`.
+
+---
+
+## Configuration tips
+
+If PowerShell isn’t on `PATH`, pass `powershell_path`:
+
+```python
+Shell(powershell_path=r"C:\Program Files\PowerShell\7\pwsh.exe")
+```
+
+Session setup example:
+
+```python
+Shell(initial_commands=[
+    "$OutputEncoding = [Console]::OutputEncoding = [Text.UTF8Encoding]::new()",
+    "$ErrorActionPreference = 'Stop'"
+])
+```
+
+---
+
+## Building from source (optional)
+
+You normally won’t need this when using wheels.
+
+**Prereqs:** Python ≥3.8, C++17, CMake ≥3.20, `scikit-build-core`, `pybind11`.
+
+```bash
+# in repo root
+python -m pip install -U pip build
+python -m build           # -> dist/*.whl, dist/*.tar.gz
+python -m pip install dist/virtualshell-*.whl
+```
+
+Editable install:
+
+```bash
+python -m pip install -e .
+```
+
+* Linux wheels target **manylinux_2_28** (x86_64/aarch64).
+* macOS builds target **x86_64** and **arm64** (may be universal2).
+
+---
+
+## Roadmap
+
+* ✅ Windows x64 wheels (3.8–3.13)
+* ✅ Linux x64/aarch64 wheels (manylinux_2_28)
+* ✅ macOS x86_64/arm64 wheels
+* ⏳ Streaming APIs and richer progress events
+
+---
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).
+
+---
+
+*Issues & feedback are welcome. Please include Python version, OS, your PowerShell path (`pwsh`/`powershell`), and a minimal repro.*

virtualshell-1.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+virtualshell/_version.py,sha256=ZgAXEMjAMZx3cZroB6PgojYwdhTZjPbU5RqZEfdYQv0,17
+virtualshell/shell.py,sha256=iHEFnbY3ggR2G-VpxAHrP3RVx3nYy1S2VxxLUTLRHa4,20915
+virtualshell/__init__.py,sha256=8PE1B8yiMyZg2gwG18EvXt2vDEflvBeAdh7mNn58-GE,912
+virtualshell/_core.cpython-312-darwin.so,sha256=Zxh919kzPm8Zqb6IGvQI7IYP5STiR-lpgjoDyoEMqDA,753320
+virtualshell/errors.py,sha256=lWOmidPiGKLef_pB-gelAF-3UbgX9Tmvu0s7JgmOg_k,193
+virtualshell-1.0.0.dist-info/RECORD,,
+virtualshell-1.0.0.dist-info/WHEEL,sha256=xZIwb9G_1TIr2zOoEWcJYpofh7wE4pGEglbCnw7TD6k,146
+virtualshell-1.0.0.dist-info/METADATA,sha256=C0_uXHh7-Lxslvmqo8JBOW1M5gK8D1YieCEVQgWf21c,20087
+virtualshell-1.0.0.dist-info/licenses/LICENSE,sha256=7RNZIZ-wB2I1pFb_4uWOXYStIFAwxbGLypaZuW-AKis,11347

virtualshell-1.0.0.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: scikit-build-core 0.11.6
+Root-Is-Purelib: false
+Tag: cp312-cp312-macosx_11_0_universal2
+Generator: delocate 0.13.0
+

virtualshell-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Kim-Andre Myrvold
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.