python-open-router 0.1.0__tar.gz → 0.3.0__tar.gz

{python_open_router-0.1.0 → python_open_router-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python_open_router
-Version: 0.1.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.1.0 → python_open_router-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python_open_router"
-version = "0.1.0"
+version = "0.3.0"
 description = "Asynchronous Python client for Open Router."
 authors = ["Joost Lekkerkerker <joostlek@outlook.com>"]
 maintainers = ["Joost Lekkerkerker <joostlek@outlook.com>"]
@@ -15,8 +15,6 @@ classifiers = [
   "Framework :: AsyncIO",
   "Intended Audience :: Developers",
   "Natural Language :: English",
-  "Programming Language :: Python :: 3.11",
-  "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: 3",
   "Topic :: Software Development :: Libraries :: Python Modules",
@@ -26,7 +24,7 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.11"
+python = "^3.13"
 aiohttp = ">=3.0.0"
 yarl = ">=1.6.0"
 mashumaro = "^3.11"
@@ -35,18 +33,18 @@ orjson = ">=3.9.0"
 [tool.poetry.group.dev.dependencies]
 codespell = "2.4.1"
 covdefaults = "2.3.0"
-coverage = {version = "7.6.12", extras = ["toml"]}
-mypy = "1.15.0"
-pre-commit = "4.1.0"
+coverage = {version = "7.9.2", extras = ["toml"]}
+mypy = "1.16.1"
+pre-commit = "4.2.0"
 pre-commit-hooks = "5.0.0"
-pylint = "3.3.4"
-pytest = "8.3.4"
-pytest-asyncio = "0.25.3"
-pytest-cov = "6.0.0"
-ruff = "0.9.6"
-safety = "3.3.0"
-yamllint = "1.35.1"
-syrupy = "4.8.1"
+pylint = "3.3.7"
+pytest = "8.4.1"
+pytest-asyncio = "1.0.0"
+pytest-cov = "6.2.1"
+ruff = "0.12.2"
+safety = "3.5.2"
+yamllint = "1.37.1"
+syrupy = "4.9.1"
 aioresponses = "0.7.8"
 
 [tool.poetry.urls]
@@ -55,6 +53,7 @@ Changelog = "https://github.com/joostlek/python-open-router/releases"
 
 [tool.coverage.report]
 show_missing = true
+fail_under = 50
 
 [tool.coverage.run]
 plugins = ["covdefaults"]
@@ -65,7 +64,7 @@ source = ["python_open_router"]
 # free to run mypy on Windows, Linux, or macOS and get consistent
 # results.
 platform = "linux"
-python_version = "3.11"
+python_version = "3.13"
 
 # show error messages from unrelated files
 follow_imports = "normal"

python_open_router-0.3.0/src/python_open_router/__init__.py

@@ -0,0 +1,39 @@
+"""Asynchronous Python client for Open Router."""
+
+from python_open_router.exceptions import (
+    OpenRouterAuthenticationError,
+    OpenRouterConnectionError,
+    OpenRouterError,
+)
+from python_open_router.models import (
+    CreatedKey,
+    CreateKeyDataWrapper,
+    Key,
+    KeyData,
+    KeyDataWrapper,
+    KeysDataWrapper,
+    Modality,
+    Model,
+    ModelArchitecture,
+    ModelsDataWrapper,
+    SupportedParameter,
+)
+from python_open_router.open_router import OpenRouterClient
+
+__all__ = [
+    "CreateKeyDataWrapper",
+    "CreatedKey",
+    "Key",
+    "KeyData",
+    "KeyDataWrapper",
+    "KeysDataWrapper",
+    "Modality",
+    "Model",
+    "ModelArchitecture",
+    "ModelsDataWrapper",
+    "OpenRouterAuthenticationError",
+    "OpenRouterClient",
+    "OpenRouterConnectionError",
+    "OpenRouterError",
+    "SupportedParameter",
+]

python_open_router-0.3.0/src/python_open_router/models.py

@@ -0,0 +1,146 @@
+"""Models for OpenRouter."""
+
+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):
+    """Wrapper for OpenRouter key data."""
+
+    data: KeyData
+
+
+@dataclass
+class KeyData(DataClassORJSONMixin):
+    """The OpenRouter key data."""
+
+    label: str
+    usage: int
+    is_provisioning_key: bool
+    limit_remaining: int | None
+    is_free_tier: bool
+
+
+@dataclass
+class KeysDataWrapper(DataClassORJSONMixin):
+    """Wrapper for OpenRouter key data."""
+
+    data: list[Key]
+
+
+@dataclass
+class CreateKeyDataWrapper(DataClassORJSONMixin):
+    """Wrapper for OpenRouter key data."""
+
+    data: CreatedKey
+
+
+@dataclass
+class Key(DataClassORJSONMixin):
+    """The OpenRouter key data."""
+
+    hash: str
+    name: str
+    label: str
+    disabled: bool
+    limit: float
+    usage: float = 0.0
+
+
+@dataclass(kw_only=True)
+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-0.1.0 → python_open_router-0.3.0}/src/python_open_router/open_router.py

@@ -9,11 +9,19 @@ import socket
 from typing import TYPE_CHECKING, Any
 
 from aiohttp import ClientError, ClientResponseError, ClientSession
-from aiohttp.hdrs import METH_GET
+from aiohttp.hdrs import METH_GET, METH_POST
 from yarl import URL
 
 from python_open_router.exceptions import OpenRouterConnectionError
-from python_open_router.models import KeyData, KeyDataWrapper
+from python_open_router.models import (
+    CreateKeyDataWrapper,
+    Key,
+    KeyData,
+    KeyDataWrapper,
+    KeysDataWrapper,
+    Model,
+    ModelsDataWrapper,
+)
 
 if TYPE_CHECKING:
     from typing_extensions import Self
@@ -89,6 +97,25 @@ class OpenRouterClient:
         response = await self._request(METH_GET, "key")
         return KeyDataWrapper.from_json(response).data
 
+    async def get_keys(self) -> list[Key]:
+        """Get all keys."""
+        response = await self._request(METH_GET, "keys")
+        return KeysDataWrapper.from_json(response).data
+
+    async def create_key(self, name: str, limit: float | None = None) -> Key:
+        """Create a new key."""
+        data: dict[str, Any] = {"name": name}
+        if limit is not None:
+            data["limit"] = limit
+
+        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.1.0/src/python_open_router/__init__.py

@@ -1,15 +0,0 @@
-"""Asynchronous Python client for Open Router."""
-
-from python_open_router.exceptions import (
-    OpenRouterAuthenticationError,
-    OpenRouterConnectionError,
-    OpenRouterError,
-)
-from python_open_router.open_router import OpenRouterClient
-
-__all__ = [
-    "OpenRouterAuthenticationError",
-    "OpenRouterClient",
-    "OpenRouterConnectionError",
-    "OpenRouterError",
-]

python_open_router-0.1.0/src/python_open_router/models.py

@@ -1,25 +0,0 @@
-"""Models for OpenRouter."""
-
-from __future__ import annotations
-
-from dataclasses import dataclass
-
-from mashumaro.mixins.orjson import DataClassORJSONMixin
-
-
-@dataclass
-class KeyDataWrapper(DataClassORJSONMixin):
-    """Wrapper for OpenRouter key data."""
-
-    data: KeyData
-
-
-@dataclass
-class KeyData(DataClassORJSONMixin):
-    """The OpenRouter key data."""
-
-    label: str
-    usage: int
-    is_provisioning_key: bool
-    limit_remaining: int | None
-    is_free_tier: bool