optimizely-opal.opal-tools-sdk 0.1.0.dev0__py3-none-any.whl → 0.1.1.dev0__py3-none-any.whl

optimizely_opal_opal_tools_sdk-0.1.1.dev0.dist-info/METADATA

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: optimizely-opal.opal-tools-sdk
+Version: 0.1.1.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.dist-info → optimizely_opal_opal_tools_sdk-0.1.1.dev0.dist-info}/RECORD

@@ -4,7 +4,7 @@ opal_tools_sdk/auth.py,sha256=9aMiZv6n6_iu7hQA0sKg4hgNr5DzYFFuP0SWUoZf_Vw,1520
 opal_tools_sdk/decorators.py,sha256=a_CJcA11RW8eAt2xRGXZane_HvTZqR7wfhn-6WFgjOY,5057
 opal_tools_sdk/models.py,sha256=fa2hhnZ2GTz6xqhGTNyqyIQj_rBE1UFQxsJ4KfApCiU,2123
 opal_tools_sdk/service.py,sha256=tVaQKFpTX778UUWoczlM2WHSiUXqdYtYSKgTdqTH1Z0,6756
-optimizely_opal_opal_tools_sdk-0.1.0.dev0.dist-info/METADATA,sha256=EoIwGaRzuaWjMlPwej56DdeTW6IcYtJDjttLigMu9ts,748
-optimizely_opal_opal_tools_sdk-0.1.0.dev0.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-optimizely_opal_opal_tools_sdk-0.1.0.dev0.dist-info/top_level.txt,sha256=nCJ5PxF0rgoV6yNJvvuUaZPx4D3EWkl7gpu-6xafH1E,15
-optimizely_opal_opal_tools_sdk-0.1.0.dev0.dist-info/RECORD,,
+optimizely_opal_opal_tools_sdk-0.1.1.dev0.dist-info/METADATA,sha256=4aDxdgUB-3Z0Je3TgjzFDtgQ9tRVpPdcRAQks0XA5j8,4115
+optimizely_opal_opal_tools_sdk-0.1.1.dev0.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+optimizely_opal_opal_tools_sdk-0.1.1.dev0.dist-info/top_level.txt,sha256=nCJ5PxF0rgoV6yNJvvuUaZPx4D3EWkl7gpu-6xafH1E,15
+optimizely_opal_opal_tools_sdk-0.1.1.dev0.dist-info/RECORD,,

optimizely_opal_opal_tools_sdk-0.1.0.dev0.dist-info/METADATA

@@ -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