swarmauri_provider_openrouter 0.1.0.dev1__tar.gz

swarmauri_provider_openrouter-0.1.0.dev1/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2024 Jacob Stewart
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

swarmauri_provider_openrouter-0.1.0.dev1/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: swarmauri_provider_openrouter
+Version: 0.1.0.dev1
+Summary: OpenRouter provider configuration, routing, catalogs, errors, and tool schemas for Swarmauri.
+License: Copyright 2024 Jacob Stewart
+         
+         Licensed under the Apache License, Version 2.0 (the "License");
+         you may not use this file except in compliance with the License.
+         You may obtain a copy of the License at
+         
+             http://www.apache.org/licenses/LICENSE-2.0
+         
+         Unless required by applicable law or agreed to in writing, software
+         distributed under the License is distributed on an "AS IS" BASIS,
+         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+         See the License for the specific language governing permissions and
+         limitations under the License.
+License-File: LICENSE
+Keywords: swarmauri,provider,openrouter,model routing,model catalog,tool calling
+Author: Jacob Stewart
+Author-email: jacob@swarmauri.com
+Requires-Python: >=3.10,<3.13
+Classifier: Development Status :: 1 - Planning
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: swarmauri_base (>=0.11.0.dev5)
+Requires-Dist: swarmauri_core (>=0.11.0.dev5)
+Description-Content-Type: text/markdown
+
+![Swarmauri Logo](https://github.com/swarmauri/swarmauri-sdk/blob/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)
+
+[![PyPI version](https://img.shields.io/pypi/v/swarmauri_provider_openrouter.svg)](https://pypi.org/project/swarmauri_provider_openrouter/) [![Python versions](https://img.shields.io/pypi/pyversions/swarmauri_provider_openrouter.svg)](https://pypi.org/project/swarmauri_provider_openrouter/) [![Downloads](https://static.pepy.tech/badge/swarmauri_provider_openrouter/month)](https://pepy.tech/project/swarmauri_provider_openrouter) [![Hits](https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_provider_openrouter.svg)](https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_provider_openrouter/) [![License](https://img.shields.io/pypi/l/swarmauri_provider_openrouter.svg)](https://pypi.org/project/swarmauri_provider_openrouter/)
+
+# swarmauri_provider_openrouter
+
+`swarmauri_provider_openrouter` describes OpenRouter authentication, endpoints,
+model metadata, routing preferences, provider errors, and tool schemas without
+owning an HTTP implementation.
+
+## Features
+
+- Bearer authentication with optional application attribution headers.
+- Capability-based resolution for chat, catalog, and image-generation APIs.
+- Provider routing, fallback, data-collection, and ZDR preferences.
+- Mutable provider catalog populated by an injected model client.
+- OpenRouter-compatible function-tool schema conversion.
+- Serializable connection configurations that exclude credentials.
+
+## Installation
+
+```bash
+uv add swarmauri_provider_openrouter
+```
+
+```bash
+pip install swarmauri_provider_openrouter
+```
+
+## Usage
+
+```python
+from swarmauri_provider_openrouter import (
+    OpenRouterProvider,
+    OpenRouterProviderPreferences,
+)
+
+provider = OpenRouterProvider(
+    api_key="...",
+    site_url="https://example.com",
+    app_name="My application",
+)
+config = provider.connection_config(
+    "chat.completions",
+    model="openai/gpt-4o-mini",
+)
+headers = provider.authorize(config)
+routing = OpenRouterProviderPreferences(order=["OpenAI"])
+```
+
+Pass the provider and routing preferences to a compatible model package. The
+provider returns connection configuration; a Swarmauri transport such as
+`swarmauri_transport_httpx` performs the request.
+
+## Project links
+
+- [Swarmauri SDK](https://github.com/swarmauri/swarmauri-sdk)
+- [OpenRouter documentation](https://openrouter.ai/docs)
+

swarmauri_provider_openrouter-0.1.0.dev1/README.md

@@ -0,0 +1,58 @@
+![Swarmauri Logo](https://github.com/swarmauri/swarmauri-sdk/blob/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)
+
+[![PyPI version](https://img.shields.io/pypi/v/swarmauri_provider_openrouter.svg)](https://pypi.org/project/swarmauri_provider_openrouter/) [![Python versions](https://img.shields.io/pypi/pyversions/swarmauri_provider_openrouter.svg)](https://pypi.org/project/swarmauri_provider_openrouter/) [![Downloads](https://static.pepy.tech/badge/swarmauri_provider_openrouter/month)](https://pepy.tech/project/swarmauri_provider_openrouter) [![Hits](https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_provider_openrouter.svg)](https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_provider_openrouter/) [![License](https://img.shields.io/pypi/l/swarmauri_provider_openrouter.svg)](https://pypi.org/project/swarmauri_provider_openrouter/)
+
+# swarmauri_provider_openrouter
+
+`swarmauri_provider_openrouter` describes OpenRouter authentication, endpoints,
+model metadata, routing preferences, provider errors, and tool schemas without
+owning an HTTP implementation.
+
+## Features
+
+- Bearer authentication with optional application attribution headers.
+- Capability-based resolution for chat, catalog, and image-generation APIs.
+- Provider routing, fallback, data-collection, and ZDR preferences.
+- Mutable provider catalog populated by an injected model client.
+- OpenRouter-compatible function-tool schema conversion.
+- Serializable connection configurations that exclude credentials.
+
+## Installation
+
+```bash
+uv add swarmauri_provider_openrouter
+```
+
+```bash
+pip install swarmauri_provider_openrouter
+```
+
+## Usage
+
+```python
+from swarmauri_provider_openrouter import (
+    OpenRouterProvider,
+    OpenRouterProviderPreferences,
+)
+
+provider = OpenRouterProvider(
+    api_key="...",
+    site_url="https://example.com",
+    app_name="My application",
+)
+config = provider.connection_config(
+    "chat.completions",
+    model="openai/gpt-4o-mini",
+)
+headers = provider.authorize(config)
+routing = OpenRouterProviderPreferences(order=["OpenAI"])
+```
+
+Pass the provider and routing preferences to a compatible model package. The
+provider returns connection configuration; a Swarmauri transport such as
+`swarmauri_transport_httpx` performs the request.
+
+## Project links
+
+- [Swarmauri SDK](https://github.com/swarmauri/swarmauri-sdk)
+- [OpenRouter documentation](https://openrouter.ai/docs)

swarmauri_provider_openrouter-0.1.0.dev1/pyproject.toml

@@ -0,0 +1,47 @@
+[project]
+name = "swarmauri_provider_openrouter"
+version = "0.1.0.dev1"
+description = "OpenRouter provider configuration, routing, catalogs, errors, and tool schemas for Swarmauri."
+readme = "README.md"
+requires-python = ">=3.10,<3.13"
+authors = [{ name = "Jacob Stewart", email = "jacob@swarmauri.com" }]
+license = { file = "LICENSE" }
+dependencies = ["swarmauri_core>=0.11.0.dev5", "swarmauri_base>=0.11.0.dev5"]
+classifiers = [
+  "Development Status :: 1 - Planning",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+]
+keywords = [
+  "swarmauri",
+  "provider",
+  "openrouter",
+  "model routing",
+  "model catalog",
+  "tool calling",
+]
+
+[tool.uv.sources]
+swarmauri_core = { workspace = true }
+swarmauri_base = { workspace = true }
+
+[project.entry-points."swarmauri.model_providers"]
+OpenRouterProvider = "swarmauri_provider_openrouter:OpenRouterProvider"
+
+[build-system]
+requires = ["poetry-core>=1.8.0"]
+build-backend = "poetry.core.masonry.api"
+
+[dependency-groups]
+dev = ["pytest>=8.0", "ruff>=0.9.9"]
+
+[tool.pytest.ini_options]
+markers = ["unit: Unit tests"]
+
+[tool.ruff]
+extend = "../../pyproject.toml"
+
+[tool.ruff.lint]
+ignore = ["N999", "RUF012"]

swarmauri_provider_openrouter-0.1.0.dev1/swarmauri_provider_openrouter/OpenRouterAuthConfig.py

@@ -0,0 +1,24 @@
+from collections.abc import Mapping
+from typing import Literal
+
+from pydantic import SecretStr
+from swarmauri_base.model_providers.ProviderAuthBase import ProviderAuthBase
+
+
+class OpenRouterAuthConfig(ProviderAuthBase):
+    api_key: SecretStr | None = None
+    site_url: str | None = None
+    app_name: str | None = None
+    type: Literal["OpenRouterAuthConfig"] = "OpenRouterAuthConfig"
+
+    def apply(self, headers: Mapping[str, str]) -> dict[str, str]:
+        authorized = dict(headers)
+        if self.api_key is not None:
+            authorized["Authorization"] = (
+                f"Bearer {self.api_key.get_secret_value()}"
+            )
+        if self.site_url:
+            authorized["HTTP-Referer"] = self.site_url
+        if self.app_name:
+            authorized["X-OpenRouter-Title"] = self.app_name
+        return authorized

swarmauri_provider_openrouter-0.1.0.dev1/swarmauri_provider_openrouter/OpenRouterEndpoints.py

@@ -0,0 +1,27 @@
+from typing import Literal
+
+from swarmauri_base.model_providers.ProviderEndpointBase import (
+    ProviderEndpointBase,
+)
+
+
+class OpenRouterEndpoints(ProviderEndpointBase):
+    base_url: str = "https://openrouter.ai/api/v1"
+    chat_completions_path: str = "/chat/completions"
+    models_path: str = "/models"
+    image_generations_path: str = "/images/generations"
+    type: Literal["OpenRouterEndpoints"] = "OpenRouterEndpoints"
+
+    def resolve(self, capability: str) -> str:
+        paths = {
+            "chat.completions": self.chat_completions_path,
+            "models.list": self.models_path,
+            "images.generate": self.image_generations_path,
+        }
+        try:
+            path = paths[capability]
+        except KeyError as error:
+            raise ValueError(
+                f"OpenRouter does not support capability {capability!r}"
+            ) from error
+        return f"{self.base_url.rstrip('/')}/{path.lstrip('/')}"

swarmauri_provider_openrouter-0.1.0.dev1/swarmauri_provider_openrouter/OpenRouterErrorMapper.py

@@ -0,0 +1,12 @@
+from typing import Any, Literal
+
+from swarmauri_base.model_providers.ProviderErrorMapperBase import (
+    ProviderErrorMapperBase,
+)
+
+
+class OpenRouterErrorMapper(ProviderErrorMapperBase):
+    type: Literal["OpenRouterErrorMapper"] = "OpenRouterErrorMapper"
+
+    def map_error(self, error: BaseException | Any) -> BaseException:
+        return RuntimeError(f"OpenRouter provider error: {error}")

swarmauri_provider_openrouter-0.1.0.dev1/swarmauri_provider_openrouter/OpenRouterModelCatalog.py

@@ -0,0 +1,41 @@
+from collections.abc import Iterable
+from typing import Any, Literal
+
+from swarmauri_base.model_providers.ModelCatalogBase import ModelCatalogBase
+
+
+class OpenRouterModelCatalog(ModelCatalogBase):
+    models: dict[str, Any] = {
+        "openrouter/auto": {
+            "id": "openrouter/auto",
+            "name": "openrouter/auto",
+            "capabilities": ["chat_completions", "streaming", "tools"],
+        }
+    }
+    type: Literal["OpenRouterModelCatalog"] = "OpenRouterModelCatalog"
+
+    def load_response(self, payload: dict[str, Any]) -> list[dict[str, Any]]:
+        models = [item for item in payload.get("data", []) if item.get("id")]
+        self.models = {item["id"]: dict(item) for item in models}
+        return models
+
+    def list_models(
+        self, *, output_modalities: str | None = None
+    ) -> Iterable[Any]:
+        models = list(self.models.values())
+        if output_modalities is None:
+            return models
+        return [
+            model
+            for model in models
+            if output_modalities
+            in (model.get("architecture", {}).get("output_modalities") or [])
+        ]
+
+    def list_model_ids(
+        self, *, output_modalities: str | None = None
+    ) -> list[str]:
+        return [
+            model.get("id") or model["name"]
+            for model in self.list_models(output_modalities=output_modalities)
+        ]

swarmauri_provider_openrouter-0.1.0.dev1/swarmauri_provider_openrouter/OpenRouterProvider.py

@@ -0,0 +1,76 @@
+from typing import Any, Literal
+
+from pydantic import Field, model_validator
+from swarmauri_base.model_providers.ModelProviderBase import ModelProviderBase
+from swarmauri_base.model_providers.ProviderConnectionConfig import (
+    ProviderConnectionConfig,
+)
+
+from .OpenRouterAuthConfig import OpenRouterAuthConfig
+from .OpenRouterEndpoints import OpenRouterEndpoints
+from .OpenRouterErrorMapper import OpenRouterErrorMapper
+from .OpenRouterModelCatalog import OpenRouterModelCatalog
+
+
+class OpenRouterProvider(ModelProviderBase):
+    provider_name: Literal["openrouter"] = "openrouter"
+    endpoints: OpenRouterEndpoints = Field(default_factory=OpenRouterEndpoints)
+    catalog: OpenRouterModelCatalog = Field(
+        default_factory=OpenRouterModelCatalog
+    )
+    error_mapper: OpenRouterErrorMapper = Field(
+        default_factory=OpenRouterErrorMapper
+    )
+    auth: OpenRouterAuthConfig = Field(
+        default_factory=OpenRouterAuthConfig, exclude=True
+    )
+    site_url: str | None = None
+    app_name: str | None = None
+    type: Literal["OpenRouterProvider"] = "OpenRouterProvider"
+
+    @model_validator(mode="after")
+    def configure(self) -> "OpenRouterProvider":
+        self.base_url = self.base_url or self.endpoints.base_url
+        self.endpoints.base_url = self.base_url
+        if self.api_key is not None:
+            self.auth.api_key = self.api_key
+        elif self.auth.api_key is not None:
+            self.api_key = self.auth.api_key
+        if self.site_url is not None:
+            self.auth.site_url = self.site_url
+        elif self.auth.site_url is not None:
+            self.site_url = self.auth.site_url
+        if self.app_name is not None:
+            self.auth.app_name = self.app_name
+        elif self.auth.app_name is not None:
+            self.app_name = self.auth.app_name
+        return self
+
+    def connection_config(
+        self,
+        capability: str,
+        model: str | None = None,
+    ) -> ProviderConnectionConfig:
+        endpoint = self.endpoints.resolve(capability)
+        options: dict[str, Any] = super().connection_options()
+        if model is not None:
+            options["model"] = model
+        return ProviderConnectionConfig(
+            endpoint=endpoint,
+            headers={
+                **self.default_headers,
+                "Accept": "application/json",
+                "Content-Type": "application/json",
+            },
+            transport_options=options,
+            auth_context=self.auth,
+        )
+
+    @staticmethod
+    def authorize(config: ProviderConnectionConfig) -> dict[str, str]:
+        auth = config.auth_context
+        if not isinstance(auth, OpenRouterAuthConfig):
+            raise TypeError(
+                "OpenRouter connection configuration has no auth context"
+            )
+        return auth.apply(config.headers)

swarmauri_provider_openrouter-0.1.0.dev1/swarmauri_provider_openrouter/OpenRouterProviderPreferences.py

@@ -0,0 +1,15 @@
+from typing import Any, Literal
+
+from pydantic import BaseModel, ConfigDict
+
+
+class OpenRouterProviderPreferences(BaseModel):
+    """Configure OpenRouter upstream-provider selection and data handling."""
+
+    order: list[str] | None = None
+    allow_fallbacks: bool = True
+    require_parameters: bool = False
+    data_collection: Literal["allow", "deny"] | None = None
+    zdr: bool | None = None
+    options: dict[str, Any] | None = None
+    model_config = ConfigDict(extra="forbid")

swarmauri_provider_openrouter-0.1.0.dev1/swarmauri_provider_openrouter/OpenRouterToolSchemaConverter.py

@@ -0,0 +1,31 @@
+from typing import Any
+
+
+class OpenRouterToolSchemaConverter:
+    def convert(self, tool: Any) -> dict[str, Any]:
+        properties: dict[str, Any] = {}
+        required: list[str] = []
+        for parameter in getattr(tool, "parameters", []):
+            schema: dict[str, Any] = {
+                "type": getattr(parameter, "input_type", "string"),
+                "description": getattr(parameter, "description", None),
+            }
+            enum = getattr(parameter, "enum", None)
+            if enum:
+                schema["enum"] = enum
+            properties[parameter.name] = schema
+            if getattr(parameter, "required", False):
+                required.append(parameter.name)
+        return {
+            "type": "function",
+            "function": {
+                "name": tool.name,
+                "description": getattr(tool, "description", None),
+                "parameters": {
+                    "type": "object",
+                    "properties": properties,
+                    "required": required,
+                    "additionalProperties": False,
+                },
+            },
+        }

swarmauri_provider_openrouter-0.1.0.dev1/swarmauri_provider_openrouter/__init__.py

@@ -0,0 +1,24 @@
+from importlib.metadata import PackageNotFoundError, version
+
+from .OpenRouterAuthConfig import OpenRouterAuthConfig
+from .OpenRouterEndpoints import OpenRouterEndpoints
+from .OpenRouterErrorMapper import OpenRouterErrorMapper
+from .OpenRouterModelCatalog import OpenRouterModelCatalog
+from .OpenRouterProvider import OpenRouterProvider
+from .OpenRouterProviderPreferences import OpenRouterProviderPreferences
+from .OpenRouterToolSchemaConverter import OpenRouterToolSchemaConverter
+
+__all__ = [
+    "OpenRouterAuthConfig",
+    "OpenRouterEndpoints",
+    "OpenRouterErrorMapper",
+    "OpenRouterModelCatalog",
+    "OpenRouterProvider",
+    "OpenRouterProviderPreferences",
+    "OpenRouterToolSchemaConverter",
+]
+
+try:
+    __version__ = version("swarmauri_provider_openrouter")
+except PackageNotFoundError:
+    __version__ = "0.0.0"