veris-ai 0.2.1__tar.gz → 1.1.0__tar.gz

{veris_ai-0.2.1 → veris_ai-1.1.0}/.github/workflows/release.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Install dependencies
         run: |
           curl -LsSf https://astral.sh/uv/install.sh | sh
-          uv sync
+          uv sync --all-extras
           uv pip install python-semantic-release
 
       - name: Configure Git

{veris_ai-0.2.1 → veris_ai-1.1.0}/.github/workflows/test.yml

@@ -2,9 +2,9 @@ name: Tests
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   test:
@@ -27,8 +27,7 @@ jobs:
 
     - name: Install dependencies
       run: |
-        uv venv
-        uv pip install -e .[dev]
+        uv sync --all-extras
 
     - name: Run code quality checks with Ruff
       run: |

{veris_ai-0.2.1 → veris_ai-1.1.0}/.gitignore

@@ -127,4 +127,6 @@ cython_debug/
 .DS_Store
 
 # Windows
-Thumbs.db 
+Thumbs.db 
+
+.scratch/

{veris_ai-0.2.1 → veris_ai-1.1.0}/CHANGELOG.md

@@ -1,5 +1,23 @@
 # CHANGELOG
 
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Session ID tracking in OTEL traces: The `veris.session_id` attribute is now automatically added to all spans when a session ID is present
+  - Session IDs from FastAPI MCP bearer tokens are automatically embedded in traces
+  - Manual session management via `veris.set_session_id()` and `veris.clear_session_id()` 
+  - Enables filtering and correlation of traces by user session in Jaeger
+- New test suite for session ID tracing functionality
+
+### Changed
+- `AgentsOTELBridgeProcessor` now imports and uses `_session_id_context` from `tool_mock`
+- Trace and span creation now includes session ID attributes when available
+
 
 ## v0.2.1 (2025-04-18)
 

veris_ai-1.1.0/CLAUDE.md

@@ -0,0 +1,185 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+This is the Veris AI Python SDK - a package that provides simulation capabilities through decorator-based function mocking and FastAPI MCP (Model Context Protocol) integration. The core functionality revolves around:
+- `VerisSDK` class in `src/veris_ai/tool_mock.py:27` - enables environment-aware execution where functions can be mocked in simulation mode or executed normally in production
+- `convert_to_type()` function in `src/veris_ai/utils.py:5` - handles sophisticated type conversion from mock responses
+- `FastApiMCPParams` model in `src/veris_ai/models.py:1` - provides configuration for integrating FastAPI applications with the Model Context Protocol
+- `set_fastapi_mcp()` method in `src/veris_ai/tool_mock.py:54` - configures FastAPI MCP server with automatic OAuth2-based session management
+
+## Development Commands
+
+This project uses `uv` as the package manager and follows modern Python tooling practices.
+
+### Setup
+```bash
+# Install with development dependencies
+uv add "veris-ai[dev]"
+
+# Install with FastAPI MCP integration
+uv add "veris-ai[fastapi]"
+
+# Set Python version (requires 3.11+)
+pyenv local 3.11.0
+```
+
+### Code Quality (Primary: Ruff)
+```bash
+# Lint code
+ruff check .
+
+# Auto-fix linting issues
+ruff check --fix .
+
+# Format code  
+ruff format .
+
+# Check formatting only
+ruff format --check .
+```
+
+### Type Checking
+```bash
+# Run static type checking
+mypy src/veris_ai tests
+```
+
+### Testing
+```bash
+# Run all tests with coverage
+pytest tests/ --cov=veris_ai --cov-report=xml --cov-report=term-missing
+
+# Run specific test file
+pytest tests/test_tool_mock.py
+
+# Run tests with verbose output
+pytest -v tests/
+```
+
+### Building
+```bash
+# Build package distributions
+uv build
+```
+
+## Code Architecture
+
+### Core Components
+
+**VerisSDK Class** (`src/veris_ai/tool_mock.py:27`)
+- Main SDK class that provides decorator functionality:
+  - `@veris.mock()`: Dynamic mocking that calls external endpoints for responses
+  - `@veris.stub()`: Simple stubbing with fixed return values
+- Environment detection: Uses `ENV` environment variable to determine simulation vs production mode
+- HTTP communication with mock endpoints via `httpx` (for mock decorator)
+- Context extraction for session management via context variables
+- Delegates type conversion to the utils module
+
+**API Surface** (`src/veris_ai/__init__.py:5`)
+- Exports single `veris` instance for public use
+- Clean, minimal API design
+
+**Type Conversion Utilities** (`src/veris_ai/utils.py:1`)
+- `convert_to_type()` function handles sophisticated type conversion from mock responses
+- Supports primitives, lists, dictionaries, unions, and custom types
+- Modular design with separate conversion functions for each type category
+- Uses Python's typing system for runtime type checking
+
+**FastAPI MCP Integration** (`src/veris_ai/models.py:1`)
+- `FastApiMCPParams` Pydantic model for configuring FastAPI MCP server integration
+- Comprehensive configuration options including:
+  - Custom server naming and descriptions
+  - HTTP client configuration (base URL, headers, timeout)
+  - Operation filtering (include/exclude by operation ID or tag)
+  - Response schema documentation controls
+  - Authentication configuration
+
+### Environment Configuration
+
+Required environment variables:
+- `VERIS_MOCK_ENDPOINT_URL`: Mock endpoint URL (required)
+- `VERIS_MOCK_TIMEOUT`: Request timeout in seconds (optional, default: 30.0)
+- `ENV`: Set to "simulation" to enable mocking, anything else runs original functions
+
+### Type System
+
+The SDK handles sophisticated type conversion from mock responses:
+- Type conversion is handled by the `convert_to_type()` function in `src/veris_ai/utils.py`
+- Supports primitives, lists, dictionaries, unions, and custom types
+- Modular design with separate handlers for different type categories
+- Uses Python's typing system for runtime type checking
+
+## Testing Strategy
+
+**Test Structure**:
+- `tests/conftest.py:1`: Pytest fixtures for environment mocking and context objects
+- `tests/test_tool_mock.py:1`: Unit tests for the VerisSDK class and mock decorator functionality
+- `tests/test_utils.py:1`: Comprehensive tests for type conversion utilities
+
+**Key Test Fixtures**:
+- `mock_context`: Provides mock context with session ID
+- `simulation_env`: Sets up simulation environment variables  
+- `production_env`: Sets up production environment variables
+
+**Test Coverage Areas**:
+- Environment-based behavior switching
+- HTTP client interactions and error handling
+- Type conversion scenarios (parametrized tests)
+- Configuration validation
+
+## Code Quality Standards
+
+**Ruff Configuration** (80+ rules enabled):
+- Line length: 100 characters
+- Target: Python 3.11+
+- Google-style docstring convention
+- Comprehensive rule set covering style, bugs, security, and complexity
+- Relaxed rules for test files (allows more flexibility in tests)
+
+**Development Tools**:
+- **Ruff**: Primary linter and formatter (replaces flake8, black, isort)
+- **MyPy**: Static type checking
+- **Pytest**: Testing with async support and coverage
+- **Pre-commit**: Git hooks for code quality
+
+## CI/CD Pipeline
+
+**Testing Workflow** (`.github/workflows/test.yml`):
+- Runs on Python 3.11, 3.12, 3.13
+- Code quality checks (Ruff lint/format)
+- Type checking (MyPy)  
+- Unit tests with coverage
+
+**Release Workflow** (`.github/workflows/release.yml`):
+- Manual trigger for releases
+- Semantic versioning with conventional commits
+- Automated PyPI publishing
+- Uses `uv build` for package building
+
+## Key Implementation Details
+
+- **Decorator Pattern**: Functions are wrapped to intercept calls in simulation mode
+  - `mock()`: Sends function metadata to external endpoint for dynamic responses
+  - `stub()`: Returns predetermined values without external calls
+- **Session Management**: Extracts session ID from context for request correlation
+- **Error Handling**: Comprehensive HTTP and type conversion error handling
+- **Async Support**: Built with async/await pattern throughout
+- **Type Safety**: Full type hints and runtime type conversion validation
+- **Modular Architecture**: Type conversion logic separated into utils module for better maintainability
+
+### FastAPI MCP Integration
+
+The `set_fastapi_mcp()` method provides:
+- **Automatic Session Handling**: OAuth2-based session ID extraction from bearer tokens
+- **Context Management**: Session IDs are stored in context variables for cross-request correlation
+- **Auth Config Merging**: User-provided auth configs are merged with internal session handling
+- **MCP Server Access**: Configured server available via `veris.fastapi_mcp` property
+
+Key implementation aspects:
+- Creates internal OAuth2PasswordBearer scheme for token extraction
+- Dependency injection for automatic session context setting
+- Preserves user auth configurations while adding session management
+- SSE (Server-Sent Events) support for streaming responses

veris_ai-1.1.0/PKG-INFO

@@ -0,0 +1,448 @@
+Metadata-Version: 2.4
+Name: veris-ai
+Version: 1.1.0
+Summary: A Python package for Veris AI tools
+Project-URL: Homepage, https://github.com/veris-ai/veris-python-sdk
+Project-URL: Bug Tracker, https://github.com/veris-ai/veris-python-sdk/issues
+Author-email: Mehdi Jamei <mehdi@veris.ai>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: requests>=2.31.0
+Provides-Extra: dev
+Requires-Dist: black>=23.7.0; extra == 'dev'
+Requires-Dist: mypy>=1.5.1; extra == 'dev'
+Requires-Dist: openai-agents>=0.0.1; extra == 'dev'
+Requires-Dist: pre-commit>=3.3.3; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.1; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest>=7.4.0; extra == 'dev'
+Requires-Dist: ruff>=0.11.4; extra == 'dev'
+Provides-Extra: fastapi
+Requires-Dist: fastapi; extra == 'fastapi'
+Requires-Dist: fastapi-mcp; extra == 'fastapi'
+Provides-Extra: instrument
+Requires-Dist: braintrust; extra == 'instrument'
+Requires-Dist: opentelemetry-api; extra == 'instrument'
+Requires-Dist: opentelemetry-exporter-otlp; extra == 'instrument'
+Requires-Dist: opentelemetry-exporter-otlp-proto-common; extra == 'instrument'
+Requires-Dist: opentelemetry-exporter-otlp-proto-grpc; extra == 'instrument'
+Requires-Dist: opentelemetry-exporter-otlp-proto-http; extra == 'instrument'
+Requires-Dist: opentelemetry-sdk; extra == 'instrument'
+Requires-Dist: wrapt; extra == 'instrument'
+Description-Content-Type: text/markdown
+
+# Veris AI Python SDK
+
+A Python package for Veris AI tools with simulation capabilities and FastAPI MCP (Model Context Protocol) integration.
+
+## Installation
+
+You can install the package using `uv`:
+
+```bash
+# Install the package
+uv add veris-ai
+
+# Install with development dependencies
+uv add "veris-ai[dev]"
+
+# Install with FastAPI MCP integration
+uv add "veris-ai[fastapi]"
+
+# Install with tracing/instrumentation support
+uv add "veris-ai[instrument]"
+```
+
+## Import Options
+
+The SDK supports flexible import patterns to minimize dependencies:
+
+### Default Imports (Base Dependencies Only)
+
+```python
+# These imports only require base dependencies (httpx, pydantic, requests)
+from veris_ai import veris, JaegerClient, SearchQuery
+```
+
+### Optional Imports (Require Extra Dependencies)
+
+```python
+# The instrument function requires the 'instrument' extra
+# Install with: pip install veris-ai[instrument] or uv add "veris-ai[instrument]"
+from veris_ai import instrument  # Lazy-loaded, will error if deps missing
+```
+
+### Direct Submodule Imports
+
+For maximum control over dependencies, you can import directly from submodules:
+
+```python
+# Import only what you need
+from veris_ai.tool_mock import veris
+from veris_ai.jaeger_interface import JaegerClient
+from veris_ai.braintrust_tracing import instrument  # Requires [instrument] extra
+```
+
+## Environment Setup
+
+The package requires the following environment variables:
+
+```bash
+# Required: URL for the mock endpoint
+VERIS_MOCK_ENDPOINT_URL=http://your-mock-endpoint.com
+
+# Optional: Timeout in seconds (default: 30.0)
+VERIS_MOCK_TIMEOUT=30.0
+
+# Optional: Set to "simulation" to enable mock mode
+ENV=simulation
+```
+
+## Tracing Integration
+
+The SDK provides seamless integration with Braintrust and Jaeger/OpenTelemetry for distributed tracing.
+
+### Setting up Tracing
+
+```python
+from veris_ai import instrument
+
+# Initialize tracing instrumentation
+instrument(
+    service_name="my-service",  # or via VERIS_SERVICE_NAME env var
+    otlp_endpoint="http://localhost:4317"  # or via VERIS_OTLP_ENDPOINT env var
+)
+```
+
+### Session ID Tracking
+
+When using the SDK with FastAPI MCP integration, session IDs are automatically embedded in all traces:
+
+1. **Automatic Session Extraction**: When a request includes an Authorization header with a bearer token, the token is automatically used as the session ID.
+
+2. **Trace Attribution**: All spans created during a request will include the `veris.session_id` attribute, allowing you to:
+   - Filter traces by session in Jaeger
+   - Correlate all operations within a single user session
+   - Debug issues specific to a particular session
+
+3. **Example**:
+   ```python
+   # FastAPI app with MCP integration
+   from fastapi import FastAPI
+   from veris_ai import veris, instrument
+   
+   app = FastAPI()
+   
+   # Set up tracing
+   instrument()
+   
+   # Set up FastAPI MCP with session handling
+   veris.set_fastapi_mcp(
+       fastapi=app,
+       name="My API Server"
+   )
+   
+   # Now all traces will automatically include session IDs from bearer tokens
+   ```
+
+4. **Manual Session Management**: You can also manually set session IDs:
+   ```python
+   veris.set_session_id("custom-session-123")
+   # All subsequent operations will be tagged with this session ID
+   veris.clear_session_id()  # Clear when done
+   ```
+
+The session ID tracking works seamlessly with both the mock decorators and the tracing system, providing end-to-end visibility of user sessions across your application.
+
+## Python Version
+
+This project requires Python 3.11 or higher. We use [pyenv](https://github.com/pyenv/pyenv) for Python version management.
+
+To set up the correct Python version:
+
+```bash
+# Install Python 3.11.0 using pyenv
+pyenv install 3.11.0
+
+# Set the local Python version for this project
+pyenv local 3.11.0
+```
+
+## Usage
+
+```python
+from veris_ai import veris
+
+@veris.mock()
+async def your_function(param1: str, param2: int) -> dict:
+    """
+    Your function documentation here.
+    
+    Args:
+        param1: Description of param1
+        param2: Description of param2
+        
+    Returns:
+        A dictionary containing the results
+    """
+    # Your implementation here
+    return {"result": "actual implementation"}
+```
+
+When `ENV=simulation` is set, the decorator will:
+1. Capture the function signature, type hints, and docstring
+2. Send this information to the mock endpoint
+3. Convert the mock response to the expected return type
+4. Return the mock result
+
+When not in simulation mode, the original function will be executed normally.
+
+### Stub Decorator
+
+For simple test scenarios where you want to return a fixed value in simulation mode, use the `@veris.stub()` decorator:
+
+```python
+from veris_ai import veris
+
+@veris.stub(return_value={"status": "success", "data": [1, 2, 3]})
+async def get_data() -> dict:
+    """Get some data from external service."""
+    # This implementation is only called in production mode
+    return await fetch_from_api()
+
+# In simulation mode: always returns {"status": "success", "data": [1, 2, 3]}
+# In production mode: calls fetch_from_api()
+```
+
+The stub decorator is useful for:
+- Quick prototyping with fixed responses
+- Testing with predictable data
+- Bypassing external dependencies in development
+
+## FastAPI MCP Integration
+
+The SDK provides integration with FastAPI applications through the Model Context Protocol (MCP). This allows your FastAPI endpoints to be exposed as MCP tools that can be used by AI agents.
+
+```python
+from fastapi import FastAPI
+from veris_ai import veris
+
+app = FastAPI()
+
+# Set up FastAPI MCP with automatic session handling
+veris.set_fastapi_mcp(
+    fastapi=app,
+    name="My API Server",
+    description="My FastAPI application exposed as MCP tools",
+    describe_all_responses=True,
+    include_operations=["get_users", "create_user"],
+    exclude_tags=["internal"]
+)
+
+# The MCP server is now available at veris.fastapi_mcp
+mcp_server = veris.fastapi_mcp
+```
+
+### Configuration Options
+
+The `set_fastapi_mcp()` method accepts the following parameters:
+
+- **fastapi** (required): Your FastAPI application instance
+- **name**: Custom name for the MCP server (defaults to app.title)
+- **description**: Custom description (defaults to app.description)
+- **describe_all_responses**: Whether to include all response schemas in tool descriptions
+- **describe_full_response_schema**: Whether to include full JSON schema for responses
+- **http_client**: Optional custom httpx.AsyncClient instance
+- **include_operations**: List of operation IDs to include as MCP tools
+- **exclude_operations**: List of operation IDs to exclude (can't use with include_operations)
+- **include_tags**: List of tags to include as MCP tools
+- **exclude_tags**: List of tags to exclude (can't use with include_tags)
+- **auth_config**: Optional FastAPI MCP AuthConfig for custom authentication
+
+### Session Management
+
+The SDK automatically handles session management through OAuth2 authentication:
+- Session IDs are extracted from bearer tokens
+- Context is maintained across API calls
+- Sessions can be managed programmatically:
+
+```python
+# Get current session ID
+session_id = veris.session_id
+
+# Set a new session ID
+veris.set_session_id("new-session-123")
+
+# Clear the session
+veris.clear_session_id()
+```
+
+## Braintrust & Jaeger Tracing
+
+The SDK includes a non-invasive instrumentation helper for sending traces to both Braintrust and a Jaeger-compatible OpenTelemetry (OTEL) collector simultaneously. This allows you to leverage Braintrust's powerful monitoring and evaluation tools while also storing and visualizing traces in your own Jaeger instance.
+
+### Usage
+
+To enable parallel tracing, simply import the `braintrust_tracing` module and call the `instrument()` function at the beginning of your application's lifecycle.
+
+```python
+from veris_ai import braintrust_tracing
+
+# Enable Braintrust and Jaeger tracing
+braintrust_tracing.instrument()
+```
+
+### Configuration
+
+The `instrument()` function is configured through environment variables:
+
+-   **`VERIS_SERVICE_NAME`** (required): The name of your service as it will appear in Jaeger.
+-   **`VERIS_OTLP_ENDPOINT`** (required): The gRPC endpoint of your Jaeger OTLP collector (e.g., `http://host.docker.internal:4317`).
+
+When initialized, the SDK automatically patches the `agents` library to send traces to both systems without any further code changes required.
+
+## Utility Functions
+
+### extract_json_schema
+
+The SDK provides a utility function to extract JSON schemas from Python types and Pydantic models:
+
+```python
+from veris_ai.utils import extract_json_schema
+from pydantic import BaseModel
+from typing import List, Optional
+
+# Extract schema from built-in types
+int_schema = extract_json_schema(int)
+# {"type": "integer"}
+
+list_schema = extract_json_schema(List[str])
+# {"type": "array", "items": {"type": "string"}}
+
+# Extract schema from Pydantic models
+class User(BaseModel):
+    name: str
+    age: int
+    email: Optional[str] = None
+
+user_schema = extract_json_schema(User)
+# Returns full JSON schema with properties, required fields, etc.
+
+# Extract schema from TypedDict
+from typing import TypedDict
+
+class Config(TypedDict):
+    host: str
+    port: int
+    debug: bool
+
+config_schema = extract_json_schema(Config)
+# {"type": "object", "properties": {...}, "required": ["host", "port", "debug"]}
+```
+
+This function supports:
+- Built-in types (str, int, float, bool, None)
+- Generic types (List, Dict, Union, Optional, Literal)
+- Pydantic models
+- TypedDict classes
+- Forward references and complex nested types
+
+## Project Structure
+
+```
+src/veris_ai/
+├── __init__.py        # Main entry point, exports the veris instance
+├── tool_mock.py       # VerisSDK class with @veris.mock() decorator
+└── utils.py           # Type conversion and JSON schema utilities
+
+tests/
+├── conftest.py        # Pytest fixtures
+├── test_tool_mock.py  # Tests for VerisSDK functionality
+└── test_utils.py      # Tests for type conversion and schema extraction
+```
+
+## Development
+
+This project uses `pyproject.toml` for dependency management and `uv` for package installation.
+
+### Development Dependencies
+
+To install the package with development dependencies:
+
+```bash
+uv add "veris-ai[dev]"
+```
+
+This will install the following development tools:
+- **Ruff**: Fast Python linter
+- **pytest**: Testing framework
+- **pytest-asyncio**: Async support for pytest
+- **pytest-cov**: Coverage reporting for pytest
+- **black**: Code formatter
+- **mypy**: Static type checker
+- **pre-commit**: Git hooks for code quality
+
+### Code Quality
+
+This project uses [Ruff](https://github.com/charliermarsh/ruff) for linting and code quality checks. Ruff is a fast Python linter written in Rust.
+
+To run Ruff:
+
+```bash
+# Lint code
+ruff check .
+
+# Auto-fix linting issues
+ruff check --fix .
+
+# Format code
+ruff format .
+
+# Check formatting only
+ruff format --check .
+```
+
+The Ruff configuration is defined in `pyproject.toml` under the `[tool.ruff]` section.
+
+### Running Tests
+
+```bash
+# Run all tests with coverage
+pytest tests/ --cov=veris_ai --cov-report=xml --cov-report=term-missing
+
+# Run specific test file
+pytest tests/test_tool_mock.py
+
+# Run tests with verbose output
+pytest -v tests/
+```
+
+### Type Checking
+
+```bash
+# Run static type checking
+mypy src/veris_ai tests
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details. 
+
+## Jaeger Trace Interface
+
+A lightweight, fully-typed wrapper around the Jaeger **Query Service** HTTP API lives under `veris_ai.jaeger_interface`.
+It allows you to **search and retrieve traces** from both Jaeger’s default storage back-ends as well as **OpenSearch**, which powers the official Jaeger UI search page.
+
+```python
+from veris_ai.jaeger_interface import JaegerClient, SearchQuery
+
+client = JaegerClient("http://localhost:16686")
+
+traces = client.search(SearchQuery(service="veris-agent", limit=2))
+first_trace = client.get_trace(traces.data[0].traceID)
+```
+
+See `src/veris_ai/jaeger_interface/README.md` for a complete walkthrough and API reference.