virtualshell 1.0.0__tar.gz → 1.0.2__tar.gz

{virtualshell-1.0.0 → virtualshell-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: virtualshell
-Version: 1.0.0
+Version: 1.0.2
 Summary: High-performance PowerShell bridge (C++ pybind11 backend)
 Keywords: powershell,automation,shell,cpp,pybind11
 Author: Kim-Andre Myrvold
@@ -217,7 +217,6 @@ 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**.  
@@ -241,12 +240,22 @@ A single long-lived PowerShell process is managed in C++, handling pipes, thread
 pip install virtualshell
 ````
 
-### Supported platforms
+## Platform & Python Support
+
+Prebuilt wheels are provided via PyPI for common platforms and Python versions.  
+This means you can usually `pip install virtualshell` without needing a compiler.
+
+**Supported Python versions:**
+- 3.8, 3.9, 3.10, 3.11, 3.12, 3.13
+
+**Supported platforms:**
+- **Windows** (x86_64, MSVC build)
+- **Linux** (x86_64, aarch64, manylinux2014/2.28)
+- **macOS** (universal2: x86_64 + arm64)
+
+If your platform is not listed above, pip will fall back to building from source.  
+See [Building from source](#building-from-source-advanced) for details.
 
-* **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).
 
@@ -334,8 +343,8 @@ By default you get a Python dataclass:
 ```python
 @dataclass(frozen=True)
 class ExecutionResult:
-    output: str
-    error: str
+    out: str
+    err: str
     exit_code: int
     success: bool
     execution_time: float
@@ -346,7 +355,7 @@ 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"`.
+* On timeout: `success=False`, `exit_code=-1`, `err` contains `"timeout"`.
 * Async futures resolve with the timeout result; late output is dropped in C++.
 
 ---
@@ -419,9 +428,8 @@ Shell(initial_commands=[
 
 ---
 
-## Building from source (optional)
-
-You normally won’t need this when using wheels.
+# Building from source (advanced)
+Source builds require a C++ toolchain and CMake.
 
 **Prereqs:** Python ≥3.8, C++17, CMake ≥3.20, `scikit-build-core`, `pybind11`.
 
@@ -439,7 +447,7 @@ python -m pip install -e .
 ```
 
 * Linux wheels target **manylinux_2_28** (x86_64/aarch64).
-* macOS builds target **x86_64** and **arm64** (may be universal2).
+* macOS builds target **universal2** (x86_64 + arm64).
 
 ---
 
@@ -458,4 +466,4 @@ Apache 2.0 — see [LICENSE](LICENSE).
 
 ---
 
-*Issues & feedback are welcome. Please include Python version, OS, your PowerShell path (`pwsh`/`powershell`), and a minimal repro.*
+*Issues & feedback are welcome. Please include Python version, OS, your PowerShell path (`pwsh`/`powershell`), and a minimal repro.*

{virtualshell-1.0.0 → virtualshell-1.0.2}/README.md

@@ -1,4 +1,3 @@
-````markdown
 # virtualshell
 
 High-performance Python façade over a **C++ PowerShell runner**.  
@@ -22,12 +21,22 @@ A single long-lived PowerShell process is managed in C++, handling pipes, thread
 pip install virtualshell
 ````
 
-### Supported platforms
+## Platform & Python Support
+
+Prebuilt wheels are provided via PyPI for common platforms and Python versions.  
+This means you can usually `pip install virtualshell` without needing a compiler.
+
+**Supported Python versions:**
+- 3.8, 3.9, 3.10, 3.11, 3.12, 3.13
+
+**Supported platforms:**
+- **Windows** (x86_64, MSVC build)
+- **Linux** (x86_64, aarch64, manylinux2014/2.28)
+- **macOS** (universal2: x86_64 + arm64)
+
+If your platform is not listed above, pip will fall back to building from source.  
+See [Building from source](#building-from-source-advanced) for details.
 
-* **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).
 
@@ -115,8 +124,8 @@ By default you get a Python dataclass:
 ```python
 @dataclass(frozen=True)
 class ExecutionResult:
-    output: str
-    error: str
+    out: str
+    err: str
     exit_code: int
     success: bool
     execution_time: float
@@ -127,7 +136,7 @@ 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"`.
+* On timeout: `success=False`, `exit_code=-1`, `err` contains `"timeout"`.
 * Async futures resolve with the timeout result; late output is dropped in C++.
 
 ---
@@ -200,9 +209,8 @@ Shell(initial_commands=[
 
 ---
 
-## Building from source (optional)
-
-You normally won’t need this when using wheels.
+# Building from source (advanced)
+Source builds require a C++ toolchain and CMake.
 
 **Prereqs:** Python ≥3.8, C++17, CMake ≥3.20, `scikit-build-core`, `pybind11`.
 
@@ -220,7 +228,7 @@ python -m pip install -e .
 ```
 
 * Linux wheels target **manylinux_2_28** (x86_64/aarch64).
-* macOS builds target **x86_64** and **arm64** (may be universal2).
+* macOS builds target **universal2** (x86_64 + arm64).
 
 ---
 
@@ -239,4 +247,4 @@ Apache 2.0 — see [LICENSE](LICENSE).
 
 ---
 
-*Issues & feedback are welcome. Please include Python version, OS, your PowerShell path (`pwsh`/`powershell`), and a minimal repro.*
+*Issues & feedback are welcome. Please include Python version, OS, your PowerShell path (`pwsh`/`powershell`), and a minimal repro.*

{virtualshell-1.0.0 → virtualshell-1.0.2}/cpp/include/virtual_shell.hpp

@@ -94,7 +94,7 @@ public:
      * @brief Configuration for the PowerShell process.
      */
     struct Config {
-        std::string powershellPath = "pwsh.exe";  ///< Path to the PowerShell executable
+        std::string powershellPath = "pwsh";      ///< Path to the PowerShell executable
         std::string workingDirectory = "";        ///< Working directory (empty = current directory)
         bool captureOutput = true;                ///< Capture stdout
         bool captureError  = true;                ///< Capture stderr

{virtualshell-1.0.0 → virtualshell-1.0.2}/cpp/src/binder.cpp

@@ -522,7 +522,7 @@ PYBIND11_MODULE(_core, m) {
     }, "Create a new VirtualShell instance", py::arg("config"));
 
     // Metadata
-    m.attr("__version__") = "1.0.0";
+    m.attr("__version__") = "1.0.2";
     m.attr("__author__")  = "Kim-Andre Myrvold";
 }
 

{virtualshell-1.0.0 → virtualshell-1.0.2}/demo.py

@@ -10,11 +10,10 @@ def example_concurrent_work():
     """
     print("=== Concurrent Work Example ===")
     
-    with Shell() as sh:
-        # Set up a PowerShell function that takes some time to execute
-        print("Setting up PowerShell function with 10 ms delay per increment...")
-        sh.run("function SlowInc { Start-Sleep -Milliseconds 10; $global:i += 1; $global:i }")
-        sh.run("$global:i = 0")
+    with Shell(timeout_seconds=30) as sh:
+
+        print("Setting up PowerShell function...")
+        sh.run("function SayHey { Start-Sleep -Milliseconds 10000; echo 'Hey from PowerShell!' }")
 
         # Results storage
         async_results = []
@@ -26,9 +25,8 @@ def example_concurrent_work():
             async_results.append(r.out.strip())
 
         # Start a long-running PowerShell command asynchronously
-        print("Starting async PowerShell execution (1000 increments)...")
-        to_run = "SlowInc;" * 1000
-        future = sh.run_async(to_run, callback=async_callback)
+        print("Starting async PowerShell execution")
+        future = sh.run_async("SayHey", callback=async_callback)
         
         print("Now doing other work while PowerShell runs in background..., max 50 iterations")
         
@@ -53,8 +51,8 @@ def example_concurrent_work():
         # Wait for async to complete if it hasn't already
         if not future.done():
             print("Waiting for PowerShell to finish...")
-            future.result()  # This will block until completion
-        
+            future.result() # This will block until poweshell finnishes the Job 
+
         elapsed = time.time() - start_time
         
         print(f"\n=== Results ===")
@@ -144,7 +142,7 @@ def example_progress_monitoring():
             - isComplete: True when the batch has finished
             - allResults: List of all ExecutionResults (filled at completion)
             """
-            msg = f"Progress: {progress.currentCommand}/{progress.totalCommands} - Last: {progress.lastResult.output.strip()}"
+            msg = f"Progress: {progress.currentCommand}/{progress.totalCommands} - Last: {progress.lastResult.out.strip()}"
             progress_updates.append(msg)
             print(f"  {msg}")
             

{virtualshell-1.0.0 → virtualshell-1.0.2}/pyproject.toml

@@ -9,7 +9,7 @@ build-backend = "scikit_build_core.build"
 [project]
 name = "virtualshell"
 description = "High-performance PowerShell bridge (C++ pybind11 backend)"
-version = "1.0.0"
+version = "1.0.2"
 readme = "README.md"
 license = { file = "LICENSE" }
 authors = [{ name = "Kim-Andre Myrvold" }]

{virtualshell-1.0.0 → virtualshell-1.0.2}/src/virtualshell/__init__.py

@@ -8,7 +8,7 @@ if TYPE_CHECKING:
 try:
     from ._version import version as __version__
 except Exception:
-    __version__ = "0.1.2"
+    __version__ = "1.0.1"
 
 
 from .errors import (

virtualshell-1.0.2/src/virtualshell/_version.py

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

{virtualshell-1.0.0 → virtualshell-1.0.2}/src/virtualshell/shell.py

@@ -116,7 +116,7 @@ def _raise_on_failure(
     """
     if res.success:
         return
-    err = (res.error or "")
+    err = (res.err 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:
@@ -168,8 +168,8 @@ class ExecutionResult:
     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", ""),
+            out=getattr(r, "out", ""),
+            err=getattr(r, "err", ""),
             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))),

virtualshell-1.0.0/src/virtualshell/_version.py

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