gatewaysdk 0.3.2__tar.gz

gatewaysdk-0.3.2/.gitignore

@@ -0,0 +1,95 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Allow vendored GEPA library (hard fork)
+!src/gatewaysdk/algorithm/gepa/lib/
+!src/gatewaysdk/algorithm/gepa/lib/**
+src/gatewaysdk/algorithm/gepa/lib/**/__pycache__/
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyright
+.pyright/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Project specific
+data/
+logs/
+*.log

gatewaysdk-0.3.2/LICENSE

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

gatewaysdk-0.3.2/PKG-INFO

@@ -0,0 +1,236 @@
+Metadata-Version: 2.5
+Name: gatewaysdk
+Version: 0.3.2
+Summary: Gateway SDK for Python - tracing, worlds, evaluation and the gateway CLI runtime
+Project-URL: Homepage, https://withgateway.ai
+Project-URL: Documentation, https://withgateway.ai/docs
+Project-URL: Repository, https://github.com/Gateway-Innovations/Gateway
+Project-URL: Issues, https://github.com/Gateway-Innovations/Gateway/issues
+Author-email: Gateway Team <team@withgateway.ai>
+License: MIT
+License-File: LICENSE
+Keywords: agents,ai,evaluation,gateway,llm,observability,reinforcement-learning,training
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: aiohttp
+Requires-Dist: aiologic
+Requires-Dist: fastapi
+Requires-Dist: flask
+Requires-Dist: gepa>=0.0.24
+Requires-Dist: gitignore-parser>=0.1.11
+Requires-Dist: graphviz
+Requires-Dist: gunicorn
+Requires-Dist: litellm>=1.74
+Requires-Dist: openai
+Requires-Dist: opentelemetry-api>=1.35
+Requires-Dist: opentelemetry-exporter-otlp>=1.35
+Requires-Dist: opentelemetry-sdk>=1.35
+Requires-Dist: portpicker
+Requires-Dist: psutil
+Requires-Dist: pydantic>=2.11
+Requires-Dist: requests>=2.31.0
+Requires-Dist: rich
+Requires-Dist: setproctitle
+Requires-Dist: tomli<3,>=2.2.1; python_version < '3.11'
+Requires-Dist: uvicorn
+Requires-Dist: uvicorn-worker
+Provides-Extra: agent
+Requires-Dist: agentops>=0.4.13; extra == 'agent'
+Requires-Dist: aiohttp>=3.8.0; extra == 'agent'
+Requires-Dist: typer>=0.9.0; extra == 'agent'
+Provides-Extra: apo
+Requires-Dist: poml; extra == 'apo'
+Provides-Extra: gpu-monitoring
+Requires-Dist: gpustat; extra == 'gpu-monitoring'
+Provides-Extra: mongo
+Requires-Dist: pymongo; extra == 'mongo'
+Provides-Extra: platform
+Requires-Dist: httpx>=0.24.0; extra == 'platform'
+Requires-Dist: jsonschema>=4.0.0; extra == 'platform'
+Requires-Dist: pyyaml>=6.0; extra == 'platform'
+Requires-Dist: typer>=0.9.0; extra == 'platform'
+Provides-Extra: proxy
+Requires-Dist: litellm[proxy]>=1.74; extra == 'proxy'
+Provides-Extra: tracing
+Requires-Dist: openinference-instrumentation-anthropic; extra == 'tracing'
+Requires-Dist: openinference-instrumentation-litellm; extra == 'tracing'
+Requires-Dist: openinference-instrumentation-openai; extra == 'tracing'
+Requires-Dist: openinference-instrumentation-openai-agents; extra == 'tracing'
+Provides-Extra: trainer
+Requires-Dist: litellm[proxy]>=1.74; extra == 'trainer'
+Provides-Extra: verl
+Requires-Dist: verl>=0.5.0; extra == 'verl'
+Requires-Dist: vllm>=0.8.4; extra == 'verl'
+Provides-Extra: weave
+Requires-Dist: weave>=0.52.22; extra == 'weave'
+Provides-Extra: worker
+Requires-Dist: bullmq>=2.19.4; extra == 'worker'
+Requires-Dist: docker>=7.0.0; extra == 'worker'
+Requires-Dist: httpx>=0.24.0; extra == 'worker'
+Requires-Dist: redis>=5.0.0; extra == 'worker'
+Requires-Dist: typer>=0.9.0; extra == 'worker'
+Description-Content-Type: text/markdown
+
+# GatewaySDK
+
+[![PyPI version](https://badge.fury.io/py/gatewaysdk.svg)](https://badge.fury.io/py/gatewaysdk)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+**AI Agent Training and Evaluation Platform**
+
+GatewaySDK is a comprehensive toolkit for training and evaluating AI agents using reinforcement learning, automatic prompt optimization, and supervised fine-tuning.
+
+## Core Features
+
+- Turn your agent into an optimizable beast with **minimal code changes**
+- Build with **any** agent framework (LangChain, OpenAI Agent SDK, AutoGen, CrewAI, and more)
+- **Selectively** optimize one or more agents in a multi-agent system
+- Embraces **algorithms** like Reinforcement Learning, Automatic Prompt Optimization, Supervised Fine-tuning and more
+
+## Installation
+
+```bash
+pip install gatewaysdk
+```
+
+For optional dependencies:
+
+```bash
+# For LLMProxy feature (note: has strict dependency pins for boto3, grpcio, uvicorn)
+pip install 'gatewaysdk[proxy]'
+
+# For Trainer (includes the proxy runtime it composes)
+pip install 'gatewaysdk[trainer]'
+
+# For GPU statistics in runner heartbeat snapshots
+pip install 'gatewaysdk[gpu-monitoring]'
+
+# For APO (Automatic Prompt Optimization)
+pip install 'gatewaysdk[apo]'
+
+# For VERL integration
+pip install 'gatewaysdk[verl]'
+
+# For Weave integration
+pip install 'gatewaysdk[weave]'
+
+# For MongoDB store
+pip install 'gatewaysdk[mongo]'
+```
+
+## Quick Start
+
+```python
+from gatewaysdk import GatewayIngestionClient
+
+# Reads GATEWAY_HOST, GATEWAY_PUBLIC_KEY, and GATEWAY_SECRET_KEY.
+client = GatewayIngestionClient.from_env()
+
+# Your agent code here...
+```
+
+## Gateway Ingestion Helpers
+
+Use these helpers when you want to send external agent traces/scores directly to
+a Gateway instance.
+
+### 1) Gateway ingestion client
+
+```python
+from gatewaysdk import GatewayIngestionClient, GatewayIngestionConfig
+
+client = GatewayIngestionClient(
+    GatewayIngestionConfig(
+        host="http://localhost:3000",
+        public_key="pk-lf-...",
+        secret_key="sk-lf-...",
+    )
+)
+
+# Send trace event
+client.ingest_trace_event(
+    trace_id="trace-001",
+    name="Agent Trace",
+    input_data={"prompt": "hello"},
+    output_data={"answer": "world"},
+    session_id="session-001",
+    environment="default",
+)
+
+# Send scores efficiently in batches
+client.send_scores(
+    [
+        {"name": "task_success", "value": 0.95, "dataType": "NUMERIC", "traceId": "trace-001"},
+        {"name": "safety", "value": 1, "dataType": "BOOLEAN", "traceId": "trace-001"},
+    ],
+    mode="ingestion-batch",
+)
+```
+
+### 2) Simple API wrapper sample (dependency-free)
+
+For a minimal stdlib-only helper and examples, see:
+`samples/gateway-agent-trace-wrapper/`.
+
+## Security Wrapper
+
+Use the security wrapper when Gateway should decide which native tools an
+agent can see and execute. Your framework keeps owning the tools; Gateway
+resolves policy, hides denied tools in filter/enforce modes, authorizes before
+execution, and stamps OpenTelemetry security attributes when tracing is active.
+
+```python
+from gatewaysdk import GatewaySecurity
+
+gw = GatewaySecurity.from_env(
+    agent={
+        "id": "support-triage",
+        "name": "Support Triage",
+        "version": "1.4.2",
+    }
+)
+
+def search_tickets(query: str) -> list[dict]:
+    return zendesk.search(query)
+
+def delete_ticket(ticket_id: str) -> dict:
+    return zendesk.delete(ticket_id)
+
+tools = gw.secure_tools(
+    toolset_id="zendesk",
+    provider="zendesk",
+    tools=[search_tickets, delete_ticket],
+    context={
+        "user_id": current_user.id,
+        "team_id": "support",
+        "environment": "production",
+        "trace_id": trace_id,
+        "session_id": session_id,
+    },
+)
+```
+
+## CLI Usage
+
+```bash
+# Start the GatewaySDK server
+msk store serve
+
+# Run with vLLM
+msk vllm start
+```
+
+## Documentation
+
+For full documentation, visit [https://docs.gateway.dev/gatewaysdk/](https://docs.gateway.dev/gatewaysdk/)
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

gatewaysdk-0.3.2/PUBLISHING.md

@@ -0,0 +1,95 @@
+# Publishing GatewaySDK to PyPI
+
+This document describes how to set up and publish the GatewaySDK package to PyPI.
+
+GatewaySDK is part of the Gateway monorepo and is published from `gatewaysdk/sdk/`.
+
+## Prerequisites
+
+1. A PyPI account (https://pypi.org/account/register/)
+2. A TestPyPI account (https://test.pypi.org/account/register/)
+3. The package built and ready to publish
+
+## Setting Up Trusted Publishing (Recommended)
+
+Trusted publishing uses OpenID Connect (OIDC) to authenticate with PyPI without needing API tokens.
+
+### Step 1: Reserve the Package Name on PyPI
+
+1. Go to https://pypi.org/manage/account/publishing/
+2. Click "Add a new pending publisher"
+3. Fill in the details:
+   - **PyPI Project Name**: `gatewaysdk`
+   - **Owner**: Your GitHub organization or username (e.g., `gateway`)
+   - **Repository name**: `gateway`
+   - **Workflow name**: `gatewaysdk-pypi-release.yml`
+   - **Environment name**: (leave blank or use `release`)
+4. Click "Add"
+
+### Step 2: Set Up TestPyPI (Optional but Recommended)
+
+1. Go to https://test.pypi.org/manage/account/publishing/
+2. Follow the same steps as above for TestPyPI (use `gatewaysdk-pypi-nightly.yml`)
+
+### Step 3: Verify GitHub Actions
+
+The workflows are configured in the gateway repo root `.github/workflows/`:
+
+- `gatewaysdk-pypi-release.yml` - Publishes to PyPI when you push a tag like `gatewaysdk-v0.1.0`
+- `gatewaysdk-pypi-nightly.yml` - Publishes nightly builds to TestPyPI
+- `gatewaysdk-test.yml` - Runs tests on changes to `gatewaysdk/sdk/`
+
+## Manual Publishing (Alternative)
+
+If you need to publish manually:
+
+```bash
+# Install build tools
+pip install build twine
+
+# Build the package
+python -m build
+
+# Upload to TestPyPI first
+python -m twine upload --repository testpypi dist/*
+
+# Test installation from TestPyPI
+pip install --index-url https://test.pypi.org/simple/ \
+    --extra-index-url https://pypi.org/simple/ gatewaysdk
+
+# Upload to PyPI
+python -m twine upload dist/*
+```
+
+## Releasing a New Version
+
+1. Update the version in `gatewaysdk/sdk/pyproject.toml` and `gatewaysdk/sdk/src/gatewaysdk/__init__.py`
+2. Commit the changes
+3. Create and push a version tag (note the `gatewaysdk-` prefix):
+   ```bash
+   git tag gatewaysdk-v0.1.0
+   git push origin gatewaysdk-v0.1.0
+   ```
+4. GitHub Actions will automatically build and publish to PyPI
+
+## Version Numbering
+
+We follow semantic versioning (SemVer):
+
+- **MAJOR.MINOR.PATCH** (e.g., `0.1.0`)
+- Increment MAJOR for breaking changes
+- Increment MINOR for new features
+- Increment PATCH for bug fixes
+
+## Troubleshooting
+
+### "Project not found" error
+
+Make sure you've set up the pending publisher on PyPI before pushing the first release tag.
+
+### "Authentication failed" error
+
+Verify that:
+1. The workflow file name matches what you configured on PyPI
+2. The repository owner/name matches
+3. The `id-token: write` permission is set in the workflow

gatewaysdk-0.3.2/README.md

@@ -0,0 +1,156 @@
+# GatewaySDK
+
+[![PyPI version](https://badge.fury.io/py/gatewaysdk.svg)](https://badge.fury.io/py/gatewaysdk)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+**AI Agent Training and Evaluation Platform**
+
+GatewaySDK is a comprehensive toolkit for training and evaluating AI agents using reinforcement learning, automatic prompt optimization, and supervised fine-tuning.
+
+## Core Features
+
+- Turn your agent into an optimizable beast with **minimal code changes**
+- Build with **any** agent framework (LangChain, OpenAI Agent SDK, AutoGen, CrewAI, and more)
+- **Selectively** optimize one or more agents in a multi-agent system
+- Embraces **algorithms** like Reinforcement Learning, Automatic Prompt Optimization, Supervised Fine-tuning and more
+
+## Installation
+
+```bash
+pip install gatewaysdk
+```
+
+For optional dependencies:
+
+```bash
+# For LLMProxy feature (note: has strict dependency pins for boto3, grpcio, uvicorn)
+pip install 'gatewaysdk[proxy]'
+
+# For Trainer (includes the proxy runtime it composes)
+pip install 'gatewaysdk[trainer]'
+
+# For GPU statistics in runner heartbeat snapshots
+pip install 'gatewaysdk[gpu-monitoring]'
+
+# For APO (Automatic Prompt Optimization)
+pip install 'gatewaysdk[apo]'
+
+# For VERL integration
+pip install 'gatewaysdk[verl]'
+
+# For Weave integration
+pip install 'gatewaysdk[weave]'
+
+# For MongoDB store
+pip install 'gatewaysdk[mongo]'
+```
+
+## Quick Start
+
+```python
+from gatewaysdk import GatewayIngestionClient
+
+# Reads GATEWAY_HOST, GATEWAY_PUBLIC_KEY, and GATEWAY_SECRET_KEY.
+client = GatewayIngestionClient.from_env()
+
+# Your agent code here...
+```
+
+## Gateway Ingestion Helpers
+
+Use these helpers when you want to send external agent traces/scores directly to
+a Gateway instance.
+
+### 1) Gateway ingestion client
+
+```python
+from gatewaysdk import GatewayIngestionClient, GatewayIngestionConfig
+
+client = GatewayIngestionClient(
+    GatewayIngestionConfig(
+        host="http://localhost:3000",
+        public_key="pk-lf-...",
+        secret_key="sk-lf-...",
+    )
+)
+
+# Send trace event
+client.ingest_trace_event(
+    trace_id="trace-001",
+    name="Agent Trace",
+    input_data={"prompt": "hello"},
+    output_data={"answer": "world"},
+    session_id="session-001",
+    environment="default",
+)
+
+# Send scores efficiently in batches
+client.send_scores(
+    [
+        {"name": "task_success", "value": 0.95, "dataType": "NUMERIC", "traceId": "trace-001"},
+        {"name": "safety", "value": 1, "dataType": "BOOLEAN", "traceId": "trace-001"},
+    ],
+    mode="ingestion-batch",
+)
+```
+
+### 2) Simple API wrapper sample (dependency-free)
+
+For a minimal stdlib-only helper and examples, see:
+`samples/gateway-agent-trace-wrapper/`.
+
+## Security Wrapper
+
+Use the security wrapper when Gateway should decide which native tools an
+agent can see and execute. Your framework keeps owning the tools; Gateway
+resolves policy, hides denied tools in filter/enforce modes, authorizes before
+execution, and stamps OpenTelemetry security attributes when tracing is active.
+
+```python
+from gatewaysdk import GatewaySecurity
+
+gw = GatewaySecurity.from_env(
+    agent={
+        "id": "support-triage",
+        "name": "Support Triage",
+        "version": "1.4.2",
+    }
+)
+
+def search_tickets(query: str) -> list[dict]:
+    return zendesk.search(query)
+
+def delete_ticket(ticket_id: str) -> dict:
+    return zendesk.delete(ticket_id)
+
+tools = gw.secure_tools(
+    toolset_id="zendesk",
+    provider="zendesk",
+    tools=[search_tickets, delete_ticket],
+    context={
+        "user_id": current_user.id,
+        "team_id": "support",
+        "environment": "production",
+        "trace_id": trace_id,
+        "session_id": session_id,
+    },
+)
+```
+
+## CLI Usage
+
+```bash
+# Start the GatewaySDK server
+msk store serve
+
+# Run with vLLM
+msk vllm start
+```
+
+## Documentation
+
+For full documentation, visit [https://docs.gateway.dev/gatewaysdk/](https://docs.gateway.dev/gatewaysdk/)
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.