Merge pull request #228 from PredicateSystems/rename2

rename sdk to predicate-runtime

Author: rcholic

.github/workflows/release.yml

@@ -283,13 +283,65 @@ jobs:
         tag_name: v${{ steps.version.outputs.version }}
         name: Release v${{ steps.version.outputs.version }}
         body: |
-          Release v${{ steps.version.outputs.version }} of predicate-sdk
+          Release v${{ steps.version.outputs.version }} of predicate-runtime
 
           ## Installation
           ```bash
-          pip install predicate-sdk==${{ steps.version.outputs.version }}
+          pip install predicate-runtime==${{ steps.version.outputs.version }}
           ```
         draft: false
         prerelease: false
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  publish-compat-shim:
+    runs-on: ubuntu-latest
+    needs: build-and-publish
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine
+
+    - name: Extract version from tag or input
+      id: version
+      run: |
+        if [ "${{ github.event_name }}" == "release" ]; then
+          VERSION=${GITHUB_REF#refs/tags/v}
+          VERSION=${VERSION#refs/tags/}
+        else
+          VERSION="${{ github.event.inputs.version }}"
+        fi
+        echo "version=$VERSION" >> $GITHUB_OUTPUT
+        echo "Version: $VERSION"
+
+    - name: Sync shim version and runtime dependency
+      run: |
+        VERSION="${{ steps.version.outputs.version }}"
+        SHIM_PYPROJECT="compat/predicate-sdk-shim/pyproject.toml"
+        sed -i "s/^version = \".*\"/version = \"$VERSION\"/" "$SHIM_PYPROJECT"
+        sed -i "s/^    \"predicate-runtime==.*\",/    \"predicate-runtime==$VERSION\",/" "$SHIM_PYPROJECT"
+
+    - name: Build compatibility shim package
+      run: |
+        python -m build compat/predicate-sdk-shim -o dist-compat
+
+    - name: Check compatibility shim package
+      run: |
+        twine check dist-compat/*
+
+    - name: Publish compatibility shim to PyPI
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+      run: |
+        twine upload dist-compat/*

.github/workflows/test.yml

@@ -33,7 +33,7 @@ jobs:
       shell: bash
       run: |
         pip cache purge || true
-        pip uninstall -y predicate-sdk predicatelabs || true
+        pip uninstall -y predicate-runtime predicate-sdk predicatelabs || true
         # Aggressively clean any bytecode cache (cross-platform Python approach)
         python -c "import pathlib; [p.unlink() for p in pathlib.Path('.').rglob('*.pyc')]" || true
         python -c "import pathlib, shutil; [shutil.rmtree(p) for p in pathlib.Path('.').rglob('__pycache__') if p.is_dir()]" || true

README.md

@@ -28,10 +28,16 @@ The core loop is:
 ## Install
 
 ```bash
-pip install predicate-sdk
+pip install predicate-runtime
 playwright install chromium
 ```
 
+Legacy install compatibility remains available through the shim package:
+
+```bash
+pip install predicate-sdk
+```
+
 If you’re developing from source (this repo), install the local checkout instead:
 
 ```bash

compat/predicate-sdk-shim/README.md

@@ -0,0 +1,10 @@
+# predicate-sdk compatibility shim
+
+This package exists to preserve install compatibility for users who still run:
+
+```bash
+pip install predicate-sdk
+```
+
+It depends on `predicate-runtime` and does not provide a separate runtime surface.
+Use canonical imports from `predicate` in your code.

compat/predicate-sdk-shim/predicate_sdk_shim.py

@@ -0,0 +1,5 @@
+"""Compatibility marker package for predicate-sdk -> predicate-runtime."""
+
+__all__ = ["__shim_target__"]
+
+__shim_target__ = "predicate-runtime"

compat/predicate-sdk-shim/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "predicate-sdk"
+version = "1.1.0"
+description = "Compatibility shim for predicate-runtime"
+readme = "README.md"
+requires-python = ">=3.11"
+license = {text = "MIT OR Apache-2.0"}
+authors = [
+    {name = "Sentience Team"}
+]
+dependencies = [
+    "predicate-runtime==1.1.0",
+]
+keywords = ["predicate", "runtime", "compatibility", "shim"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+]
+
+[project.urls]
+Homepage = "https://github.com/Predicate-Labs/sdk-python"
+Repository = "https://github.com/Predicate-Labs/sdk-python"
+Issues = "https://github.com/Predicate-Labs/sdk-python/issues"
+
+[tool.setuptools]
+py-modules = ["predicate_sdk_shim"]

examples/browser-use/README.md

@@ -16,13 +16,13 @@ This directory contains examples for integrating [Sentience](https://github.com/
 Install both packages together using the optional dependency:
 
 ```bash
-pip install "predicate-sdk[browser-use]"
+pip install "predicate-runtime[browser-use]"
 ```
 
 Or install separately:
 
 ```bash
-pip install predicate-sdk browser-use
+pip install predicate-runtime browser-use
 ```
 
 ## Quick Start

examples/browser-use/integration.py

@@ -6,10 +6,10 @@
 using Sentience's snapshot-based grounding instead of coordinate estimation.
 
 Requirements:
-    pip install "predicate-sdk[browser-use]" python-dotenv
+    pip install "predicate-runtime[browser-use]" python-dotenv
 
     Or install separately:
-    pip install predicate-sdk browser-use python-dotenv
+    pip install predicate-runtime browser-use python-dotenv
 
 Usage:
     python examples/browser-use/integration.py
@@ -240,7 +240,7 @@ async def example_with_sentience_context() -> None:
     print("Extension path:", get_extension_dir())
     print()
     print("To run with a real browser:")
-    print('  1. pip install "predicate-sdk[browser-use]" python-dotenv')
+    print('  1. pip install "predicate-runtime[browser-use]" python-dotenv')
     print("  2. Uncomment the browser-use imports and code sections")
     print("  3. Run: python examples/browser-use/integration.py")
 

examples/lang-chain/README.md

@@ -5,7 +5,7 @@ These examples show how to use Sentience as a **tool layer** inside LangChain an
 Install:
 
 ```bash
-pip install predicate-sdk[langchain]
+pip install predicate-runtime[langchain]
 ```
 
 Examples:

examples/lang-chain/langchain_tools_demo.py

@@ -2,7 +2,7 @@
 Example: Build Sentience LangChain tools (async-only).
 
 Install:
-  pip install predicate-sdk[langchain]
+  pip install predicate-runtime[langchain]
 
 Run:
   python examples/lang-chain/langchain_tools_demo.py