optimizely-opal.opal-tools-sdk 0.1.0.dev0__tar.gz → 0.1.2.dev0__tar.gz

optimizely_opal_opal_tools_sdk-0.1.2.dev0/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: optimizely-opal.opal-tools-sdk
+Version: 0.1.2.dev0
+Summary: SDK for creating Opal-compatible tools services
+Home-page: https://github.com/optimizely/opal-tools-sdk
+Author: Optimizely
+Author-email: Optimizely <opal-team@optimizely.com>
+License: MIT
+Project-URL: Homepage, https://github.com/optimizely/opal-tools-sdk
+Project-URL: Bug Tracker, https://github.com/optimizely/opal-tools-sdk/issues
+Keywords: opal,tools,sdk,ai,llm
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: httpx>=0.24.1
+Dynamic: author
+Dynamic: home-page
+Dynamic: requires-python
+
+# Opal Tools SDK for Python
+
+This SDK simplifies the creation of tools services compatible with the Opal Tools Management Service.
+
+## Features
+
+- Easy definition of tool functions with decorators
+- Automatic generation of discovery endpoints
+- Parameter validation and type checking
+- Authentication helpers
+- FastAPI integration
+
+## Installation
+
+```bash
+pip install optimizely-opal.opal-tools-sdk
+```
+
+Note: While the package is installed as `optimizely-opal.opal-tools-sdk`, you'll still import it in your code as `opal_tools_sdk`:
+
+```python
+# Import using the package name
+from opal_tools_sdk import ToolsService, tool
+```
+
+## Usage
+
+```python
+from opal_tools_sdk import ToolsService, tool
+from pydantic import BaseModel
+from fastapi import FastAPI
+
+app = FastAPI()
+tools_service = ToolsService(app)
+
+class WeatherParameters(BaseModel):
+    location: str
+    units: str = "metric"
+
+@tool("get_weather", "Gets current weather for a location")
+async def get_weather(parameters: WeatherParameters):
+    # Implementation...
+    return {"temperature": 22, "condition": "sunny"}
+
+# Discovery endpoint is automatically created at /discovery
+```
+
+## Authentication
+
+The SDK provides two ways to require authentication for your tools:
+
+### 1. Using the `@requires_auth` decorator
+
+```python
+from opal_tools_sdk import ToolsService, tool
+from opal_tools_sdk.auth import requires_auth
+from pydantic import BaseModel
+from fastapi import FastAPI
+
+app = FastAPI()
+tools_service = ToolsService(app)
+
+class CalendarParameters(BaseModel):
+    date: str
+    timezone: str = "UTC"
+
+# Single authentication requirement
+@requires_auth(provider="google", scope_bundle="calendar", required=True)
+@tool("get_calendar_events", "Gets calendar events for a date")
+async def get_calendar_events(parameters: CalendarParameters, auth_data=None):
+    # The auth_data parameter contains authentication information
+    token = auth_data.get("credentials", {}).get("token", "")
+
+    # Use the token to make authenticated requests
+    # ...
+
+    return {"events": ["Meeting at 10:00", "Lunch at 12:00"]}
+
+# Multiple authentication requirements (tool can work with either provider)
+@requires_auth(provider="google", scope_bundle="calendar", required=True)
+@requires_auth(provider="microsoft", scope_bundle="outlook", required=True)
+@tool("get_calendar_availability", "Check calendar availability")
+async def get_calendar_availability(parameters: CalendarParameters, auth_data=None):
+    provider = auth_data.get("provider", "")
+    token = auth_data.get("credentials", {}).get("token", "")
+
+    if provider == "google":
+        # Use Google Calendar API
+        pass
+    elif provider == "microsoft":
+        # Use Microsoft Outlook API
+        pass
+
+    return {"available": True, "provider_used": provider}
+```
+
+### 2. Specifying auth requirements in the `@tool` decorator
+
+```python
+@tool(
+    "get_email",
+    "Gets emails from the user's inbox",
+    auth_requirements=[
+        {"provider": "google", "scope_bundle": "gmail", "required": True}
+    ]
+)
+async def get_email(parameters: EmailParameters, auth_data=None):
+    # Implementation...
+    return {"emails": ["Email 1", "Email 2"]}
+```
+
+## Documentation
+
+See full documentation for more examples and configuration options.

{optimizely_opal_opal_tools_sdk-0.1.0.dev0 → optimizely_opal_opal_tools_sdk-0.1.2.dev0}/opal_tools_sdk/decorators.py

@@ -75,7 +75,11 @@ def tool(name: str, description: str, auth_requirements: Optional[List[Dict[str,
                     param_type = ParameterType.dictionary
 
                 # Determine if required
-                required = field_info.default is ... if hasattr(field_info, 'default') else True
+                field_info_extra = getattr(field_info, "json_schema_extra") or {}
+                if "required" in field_info_extra:
+                    required = field_info_extra["required"]
+                else:
+                    required = field_info.default is ... if hasattr(field_info, 'default') else True
 
                 # Get description
                 description_text = ""

{optimizely_opal_opal_tools_sdk-0.1.0.dev0 → optimizely_opal_opal_tools_sdk-0.1.2.dev0}/opal_tools_sdk/service.py

@@ -132,6 +132,11 @@ class ToolsService:
                 if auth_data:
                     print(f"Auth data provided for provider: {auth_data.get('provider', 'unknown')}")
 
+                # Extract environment data if available
+                environment = body.get("environment", {})
+                if environment:
+                    print(f"Environment data provided: {environment}")
+
                 print(f"Extracted parameters: {params}")
 
                 # Get the parameter model from handler's signature
@@ -139,24 +144,27 @@ class ToolsService:
                 param_name = list(sig.parameters.keys())[0]
                 param_type = get_type_hints(handler).get(param_name)
 
-                # Check signature to see if it accepts auth data
-                accepts_auth = len(sig.parameters) > 1
 
+                args = []
+                kwargs = {}
                 if param_type:
                     # Create instance of param model
                     model_instance = param_type(**params)
-                    if accepts_auth:
-                        # Call with auth data if the handler accepts it
-                        result = await handler(model_instance, auth_data)
-                    else:
-                        # Call without auth data
-                        result = await handler(model_instance)
+                    args.append(model_instance)
                 else:
                     # Fall back if type hints not available
-                    if accepts_auth:
-                        result = await handler(BaseModel(**params), auth_data)
-                    else:
-                        result = await handler(BaseModel(**params))
+                    args.append(BaseModel(**params))
+
+                # Check signature to see if it accepts other values
+
+                # TODO: Change this to "auth"
+                if auth_param := sig.parameters.get("auth_data"):
+                    kwargs[auth_param.name] = auth_data
+
+                if environment_param := sig.parameters.get("environment"):
+                    kwargs[environment_param.name] = environment
+
+                result = await handler(*args, **kwargs)
 
                 print(f"Tool {name} returned: {result}")
                 return result

optimizely_opal_opal_tools_sdk-0.1.2.dev0/optimizely_opal.opal_tools_sdk.egg-info/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: optimizely-opal.opal-tools-sdk
+Version: 0.1.2.dev0
+Summary: SDK for creating Opal-compatible tools services
+Home-page: https://github.com/optimizely/opal-tools-sdk
+Author: Optimizely
+Author-email: Optimizely <opal-team@optimizely.com>
+License: MIT
+Project-URL: Homepage, https://github.com/optimizely/opal-tools-sdk
+Project-URL: Bug Tracker, https://github.com/optimizely/opal-tools-sdk/issues
+Keywords: opal,tools,sdk,ai,llm
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: httpx>=0.24.1
+Dynamic: author
+Dynamic: home-page
+Dynamic: requires-python
+
+# Opal Tools SDK for Python
+
+This SDK simplifies the creation of tools services compatible with the Opal Tools Management Service.
+
+## Features
+
+- Easy definition of tool functions with decorators
+- Automatic generation of discovery endpoints
+- Parameter validation and type checking
+- Authentication helpers
+- FastAPI integration
+
+## Installation
+
+```bash
+pip install optimizely-opal.opal-tools-sdk
+```
+
+Note: While the package is installed as `optimizely-opal.opal-tools-sdk`, you'll still import it in your code as `opal_tools_sdk`:
+
+```python
+# Import using the package name
+from opal_tools_sdk import ToolsService, tool
+```
+
+## Usage
+
+```python
+from opal_tools_sdk import ToolsService, tool
+from pydantic import BaseModel
+from fastapi import FastAPI
+
+app = FastAPI()
+tools_service = ToolsService(app)
+
+class WeatherParameters(BaseModel):
+    location: str
+    units: str = "metric"
+
+@tool("get_weather", "Gets current weather for a location")
+async def get_weather(parameters: WeatherParameters):
+    # Implementation...
+    return {"temperature": 22, "condition": "sunny"}
+
+# Discovery endpoint is automatically created at /discovery
+```
+
+## Authentication
+
+The SDK provides two ways to require authentication for your tools:
+
+### 1. Using the `@requires_auth` decorator
+
+```python
+from opal_tools_sdk import ToolsService, tool
+from opal_tools_sdk.auth import requires_auth
+from pydantic import BaseModel
+from fastapi import FastAPI
+
+app = FastAPI()
+tools_service = ToolsService(app)
+
+class CalendarParameters(BaseModel):
+    date: str
+    timezone: str = "UTC"
+
+# Single authentication requirement
+@requires_auth(provider="google", scope_bundle="calendar", required=True)
+@tool("get_calendar_events", "Gets calendar events for a date")
+async def get_calendar_events(parameters: CalendarParameters, auth_data=None):
+    # The auth_data parameter contains authentication information
+    token = auth_data.get("credentials", {}).get("token", "")
+
+    # Use the token to make authenticated requests
+    # ...
+
+    return {"events": ["Meeting at 10:00", "Lunch at 12:00"]}
+
+# Multiple authentication requirements (tool can work with either provider)
+@requires_auth(provider="google", scope_bundle="calendar", required=True)
+@requires_auth(provider="microsoft", scope_bundle="outlook", required=True)
+@tool("get_calendar_availability", "Check calendar availability")
+async def get_calendar_availability(parameters: CalendarParameters, auth_data=None):
+    provider = auth_data.get("provider", "")
+    token = auth_data.get("credentials", {}).get("token", "")
+
+    if provider == "google":
+        # Use Google Calendar API
+        pass
+    elif provider == "microsoft":
+        # Use Microsoft Outlook API
+        pass
+
+    return {"available": True, "provider_used": provider}
+```
+
+### 2. Specifying auth requirements in the `@tool` decorator
+
+```python
+@tool(
+    "get_email",
+    "Gets emails from the user's inbox",
+    auth_requirements=[
+        {"provider": "google", "scope_bundle": "gmail", "required": True}
+    ]
+)
+async def get_email(parameters: EmailParameters, auth_data=None):
+    # Implementation...
+    return {"emails": ["Email 1", "Email 2"]}
+```
+
+## Documentation
+
+See full documentation for more examples and configuration options.

{optimizely_opal_opal_tools_sdk-0.1.0.dev0 → optimizely_opal_opal_tools_sdk-0.1.2.dev0}/optimizely_opal.opal_tools_sdk.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 README.md
+pyproject.toml
 setup.py
 opal_tools_sdk/__init__.py
 opal_tools_sdk/_registry.py

optimizely_opal_opal_tools_sdk-0.1.2.dev0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "optimizely-opal.opal-tools-sdk"
+version = "0.1.2-dev"
+description = "SDK for creating Opal-compatible tools services"
+authors = [
+    {name = "Optimizely", email = "opal-team@optimizely.com"}
+]
+readme = "README.md"
+requires-python = ">=3.10"
+keywords = ["opal", "tools", "sdk", "ai", "llm"]
+license = {text = "MIT"}
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3.10",
+    "License :: OSI Approved :: MIT License",
+]
+dependencies = [
+    "fastapi>=0.100.0",
+    "pydantic>=2.0.0",
+    "httpx>=0.24.1",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/optimizely/opal-tools-sdk"
+"Bug Tracker" = "https://github.com/optimizely/opal-tools-sdk/issues"
+
+[tool.setuptools]
+packages = ["opal_tools_sdk"]

{optimizely_opal_opal_tools_sdk-0.1.0.dev0 → optimizely_opal_opal_tools_sdk-0.1.2.dev0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="optimizely-opal.opal-tools-sdk",
-    version="0.1.0-dev",
+    version="0.1.1-dev",
     packages=find_packages(),
     install_requires=[
         "fastapi>=0.100.0",

optimizely_opal_opal_tools_sdk-0.1.0.dev0/PKG-INFO

@@ -1,24 +0,0 @@
-Metadata-Version: 2.4
-Name: optimizely-opal.opal-tools-sdk
-Version: 0.1.0.dev0
-Summary: SDK for creating Opal-compatible tools services
-Home-page: https://github.com/optimizely/opal-tools-sdk
-Author: Optimizely
-Author-email: opal-team@optimizely.com
-Keywords: opal,tools,sdk,ai,llm
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3.10
-Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.10
-Requires-Dist: fastapi>=0.100.0
-Requires-Dist: pydantic>=2.0.0
-Requires-Dist: httpx>=0.24.1
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary

optimizely_opal_opal_tools_sdk-0.1.0.dev0/optimizely_opal.opal_tools_sdk.egg-info/PKG-INFO

@@ -1,24 +0,0 @@
-Metadata-Version: 2.4
-Name: optimizely-opal.opal-tools-sdk
-Version: 0.1.0.dev0
-Summary: SDK for creating Opal-compatible tools services
-Home-page: https://github.com/optimizely/opal-tools-sdk
-Author: Optimizely
-Author-email: opal-team@optimizely.com
-Keywords: opal,tools,sdk,ai,llm
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3.10
-Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.10
-Requires-Dist: fastapi>=0.100.0
-Requires-Dist: pydantic>=2.0.0
-Requires-Dist: httpx>=0.24.1
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary