python-open-router 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

python_open_router/__init__.py

@@ -12,6 +12,11 @@ from python_open_router.models import (
     KeyData,
     KeyDataWrapper,
     KeysDataWrapper,
+    Modality,
+    Model,
+    ModelArchitecture,
+    ModelsDataWrapper,
+    SupportedParameter,
 )
 from python_open_router.open_router import OpenRouterClient
 
@@ -22,8 +27,13 @@ __all__ = [
     "KeyData",
     "KeyDataWrapper",
     "KeysDataWrapper",
+    "Modality",
+    "Model",
+    "ModelArchitecture",
+    "ModelsDataWrapper",
     "OpenRouterAuthenticationError",
     "OpenRouterClient",
     "OpenRouterConnectionError",
     "OpenRouterError",
+    "SupportedParameter",
 ]

python_open_router/models.py

@@ -3,9 +3,14 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
+from enum import StrEnum
+import logging
+from typing import Any
 
 from mashumaro.mixins.orjson import DataClassORJSONMixin
 
+_LOGGER = logging.getLogger(__package__)
+
 
 @dataclass
 class KeyDataWrapper(DataClassORJSONMixin):
@@ -56,3 +61,86 @@ class CreatedKey(Key):
     """Created key."""
 
     key: str
+
+
+@dataclass
+class ModelsDataWrapper(DataClassORJSONMixin):
+    """Wrapper for OpenRouter model data."""
+
+    data: list[Model]
+
+
+class SupportedParameter(StrEnum):
+    """Supported parameters for models."""
+
+    TEMPERATURE = "temperature"
+    TOP_P = "top_p"
+    MAX_TOKENS = "max_tokens"
+    REASONING = "reasoning"
+    INCLUDE_REASONING = "include_reasoning"
+    STOP = "stop"
+    TOK_K = "top_k"
+    SEED = "seed"
+    RESPONSE_FORMAT = "response_format"
+    TOOLS = "tools"
+    TOOL_CHOICE = "tool_choice"
+    FREQUENCY_PENALTY = "frequency_penalty"
+    PRESENCE_PENALTY = "presence_penalty"
+    MIN_P = "min_p"
+    REPETITION_PENALTY = "repetition_penalty"
+    LOGPROBS = "logprobs"
+    LOGIT_BIAS = "logit_bias"
+    TOP_LOGPROBS = "top_logprobs"
+    STRUCTURED_OUTPUTS = "structured_outputs"
+    WEB_SEARCH_OPTIONS = "web_search_options"
+    TOP_A = "top_a"
+
+
+class Modality(StrEnum):
+    """Supported modalities for models."""
+
+    TEXT = "text"
+    IMAGE = "image"
+    FILE = "file"
+
+
+@dataclass(kw_only=True)
+class ModelArchitecture(DataClassORJSONMixin):
+    """Model data."""
+
+    input_modalities: list[Modality]
+    output_modalities: list[Modality]
+
+
+@dataclass(kw_only=True)
+class Model(DataClassORJSONMixin):
+    """Model data."""
+
+    id: str
+    canonical_slug: str
+    hugging_face_id: str | None
+    name: str
+    description: str
+    context_length: int
+    architecture: ModelArchitecture
+    supported_parameters: list[SupportedParameter]
+
+    @classmethod
+    def __pre_deserialize__(cls, d: dict[str, Any]) -> dict[str, Any]:
+        """Pre deserialize hook."""
+        parameters = d.get("supported_parameters", [])
+        for parameter in parameters:
+            if parameter not in SupportedParameter:
+                _LOGGER.warning(
+                    "Unsupported parameter: %s. Please report at https://github.com/joostlek/python-open-router/issues.",
+                    parameter,
+                )
+                parameters.remove(parameter)
+        return d
+
+    @classmethod
+    def __post_deserialize__(cls, obj: Model) -> Model:
+        """Post deserialize hook."""
+        if obj.hugging_face_id == "":
+            obj.hugging_face_id = None
+        return obj

python_open_router/open_router.py

@@ -19,6 +19,8 @@ from python_open_router.models import (
     KeyData,
     KeyDataWrapper,
     KeysDataWrapper,
+    Model,
+    ModelsDataWrapper,
 )
 
 if TYPE_CHECKING:
@@ -109,6 +111,11 @@ class OpenRouterClient:
         response = await self._request(METH_POST, "keys", data=data)
         return CreateKeyDataWrapper.from_json(response).data
 
+    async def get_models(self) -> list[Model]:
+        """Get all available models."""
+        response = await self._request(METH_GET, "models")
+        return ModelsDataWrapper.from_json(response).data
+
     async def close(self) -> None:
         """Close open client session."""
         if self.session and self._close_session:

{python_open_router-0.2.0.dist-info → python_open_router-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python_open_router
-Version: 0.2.0
+Version: 0.3.0
 Summary: Asynchronous Python client for Open Router.
 License: MIT
 Keywords: OpenRouter,api,async,client
@@ -8,15 +8,13 @@ Author: Joost Lekkerkerker
 Author-email: joostlek@outlook.com
 Maintainer: Joost Lekkerkerker
 Maintainer-email: joostlek@outlook.com
-Requires-Python: >=3.11,<4.0
+Requires-Python: >=3.13,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: AsyncIO
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: aiohttp (>=3.0.0)

python_open_router-0.3.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+python_open_router/__init__.py,sha256=UQt6SpcnmQkS2wiyjwA_Ggvvzu7Ucx8BOCyZLZ_F2uA,840
+python_open_router/exceptions.py,sha256=68nskqNdXNMIK4iA1XOE1E5P5rbhAf27DDACkk-ZVwU,312
+python_open_router/models.py,sha256=ax1sfcdnvby1zqnlFyQ9v21eDFDKfk8uTUmvguNeNwU,3309
+python_open_router/open_router.py,sha256=zq7aleWZfNFqbBb69Qp3_3jed95cwxtgGMlYFhDzYKw,4148
+python_open_router/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+python_open_router-0.3.0.dist-info/LICENSE.md,sha256=Xbw7n2Ic30r4j8_MDNND4ss_sdoj9IGeIkEWc2Hsfs8,1077
+python_open_router-0.3.0.dist-info/METADATA,sha256=H8In-JGkpn_P5GHOLI3MpodKkEB9R7s4wzzq9F6TuDE,5928
+python_open_router-0.3.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+python_open_router-0.3.0.dist-info/RECORD,,

{python_open_router-0.2.0.dist-info → python_open_router-0.3.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.2
+Generator: poetry-core 2.1.3
 Root-Is-Purelib: true
 Tag: py3-none-any

python_open_router-0.2.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-python_open_router/__init__.py,sha256=dmD0nHFaJzzKYD7Q4Ltm9p46uBhAOLpPTnWVyH_KHH8,640
-python_open_router/exceptions.py,sha256=68nskqNdXNMIK4iA1XOE1E5P5rbhAf27DDACkk-ZVwU,312
-python_open_router/models.py,sha256=qIKy3bqx-RnwlbwV4kgTPuDkbII4xPq2PE3gA8mShwo,999
-python_open_router/open_router.py,sha256=WOJtZ40l3dv8_GGWRV1caN--KAgv0g0KfNdl-KzGGLM,3909
-python_open_router/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-python_open_router-0.2.0.dist-info/LICENSE.md,sha256=Xbw7n2Ic30r4j8_MDNND4ss_sdoj9IGeIkEWc2Hsfs8,1077
-python_open_router-0.2.0.dist-info/METADATA,sha256=iYrSXHhOj1w-vHE51V3JZoIdNcjrfkedqw-wuILzYVg,6030
-python_open_router-0.2.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-python_open_router-0.2.0.dist-info/RECORD,,