python-open-router 0.1.0__py3-none-any.whl

python_open_router/__init__.py

@@ -0,0 +1,15 @@
+"""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/exceptions.py

@@ -0,0 +1,13 @@
+"""Asynchronous Python client for OpenRouter."""
+
+
+class OpenRouterError(Exception):
+    """Generic exception."""
+
+
+class OpenRouterConnectionError(OpenRouterError):
+    """OpenRouter connection exception."""
+
+
+class OpenRouterAuthenticationError(OpenRouterError):
+    """OpenRouter authentication exception."""

python_open_router/models.py

@@ -0,0 +1,25 @@
+"""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

python_open_router/open_router.py

@@ -0,0 +1,115 @@
+"""Asynchronous Python client for Open Router."""
+
+from __future__ import annotations
+
+import asyncio
+from dataclasses import dataclass
+from importlib import metadata
+import socket
+from typing import TYPE_CHECKING, Any
+
+from aiohttp import ClientError, ClientResponseError, ClientSession
+from aiohttp.hdrs import METH_GET
+from yarl import URL
+
+from python_open_router.exceptions import OpenRouterConnectionError
+from python_open_router.models import KeyData, KeyDataWrapper
+
+if TYPE_CHECKING:
+    from typing_extensions import Self
+
+
+VERSION = metadata.version(__package__)
+HOST = "openrouter.ai"
+
+
+@dataclass
+class OpenRouterClient:
+    """Main class for handling connections with OpenRouter."""
+
+    api_key: str
+    session: ClientSession | None = None
+    request_timeout: int = 10
+    _close_session: bool = False
+
+    async def _request(
+        self,
+        method: str,
+        uri: str,
+        *,
+        params: dict[str, Any] | None = None,
+        data: dict[str, Any] | None = None,
+    ) -> str:
+        """Handle a request to OpenRouter."""
+        url = URL.build(host=HOST, scheme="https").joinpath(f"api/v1/{uri}")
+
+        headers = {
+            "User-Agent": f"PythonOpenRouter/{VERSION}",
+            "Accept": "application/json",
+            "Authorization": f"Bearer {self.api_key}",
+        }
+
+        if self.session is None:
+            self.session = ClientSession()
+            self._close_session = True
+
+        try:
+            async with asyncio.timeout(self.request_timeout):
+                response = await self.session.request(
+                    method,
+                    url,
+                    params=params,
+                    headers=headers,
+                    json=data,
+                )
+        except asyncio.TimeoutError as exception:
+            msg = "Timeout occurred while connecting to the service"
+            raise OpenRouterConnectionError(msg) from exception
+        except (
+            ClientError,
+            ClientResponseError,
+            socket.gaierror,
+        ) as exception:
+            msg = "Error occurred while communicating with the service"
+            raise OpenRouterConnectionError(msg) from exception
+
+        if response.status >= 400:
+            content_type = response.headers.get("Content-Type", "")
+            text = await response.text()
+            msg = "Unexpected response from OpenRouter"
+            raise OpenRouterConnectionError(
+                msg,
+                {"Content-Type": content_type, "response": text},
+            )
+
+        return await response.text()
+
+    async def get_key_data(self) -> KeyData:
+        """Get key data for API key."""
+        response = await self._request(METH_GET, "key")
+        return KeyDataWrapper.from_json(response).data
+
+    async def close(self) -> None:
+        """Close open client session."""
+        if self.session and self._close_session:
+            await self.session.close()
+
+    async def __aenter__(self) -> Self:
+        """Async enter.
+
+        Returns
+        -------
+            The OpenRouterClient object.
+
+        """
+        return self
+
+    async def __aexit__(self, *_exc_info: object) -> None:
+        """Async exit.
+
+        Args:
+        ----
+            _exc_info: Exec type.
+
+        """
+        await self.close()

python_open_router-0.1.0.dist-info/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2025 Joost Lekkerkerker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

python_open_router-0.1.0.dist-info/METADATA

@@ -0,0 +1,163 @@
+Metadata-Version: 2.3
+Name: python_open_router
+Version: 0.1.0
+Summary: Asynchronous Python client for Open Router.
+License: MIT
+Keywords: OpenRouter,api,async,client
+Author: Joost Lekkerkerker
+Author-email: joostlek@outlook.com
+Maintainer: Joost Lekkerkerker
+Maintainer-email: joostlek@outlook.com
+Requires-Python: >=3.11,<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)
+Requires-Dist: mashumaro (>=3.11,<4.0)
+Requires-Dist: orjson (>=3.9.0)
+Requires-Dist: yarl (>=1.6.0)
+Project-URL: Bug Tracker, https://github.com/joostlek/python-open-router/issues
+Project-URL: Changelog, https://github.com/joostlek/python-open-router/releases
+Project-URL: Documentation, https://github.com/joostlek/python-open-router
+Project-URL: Homepage, https://github.com/joostlek/python-open-router
+Project-URL: Repository, https://github.com/joostlek/python-open-router
+Description-Content-Type: text/markdown
+
+# Python: Open Router
+
+[![GitHub Release][releases-shield]][releases]
+[![Python Versions][python-versions-shield]][pypi]
+![Project Stage][project-stage-shield]
+![Project Maintenance][maintenance-shield]
+[![License][license-shield]](LICENSE.md)
+
+[![Build Status][build-shield]][build]
+[![Code Coverage][codecov-shield]][codecov]
+
+Asynchronous Python client for Open Router.
+
+## About
+
+This package allows you to fetch data from Open Router.
+
+## Installation
+
+```bash
+pip install python-open-router
+```
+
+
+## Changelog & Releases
+
+This repository keeps a change log using [GitHub's releases][releases]
+functionality. The format of the log is based on
+[Keep a Changelog][keepchangelog].
+
+Releases are based on [Semantic Versioning][semver], and use the format
+of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented
+based on the following:
+
+- ``MAJOR``: Incompatible or major changes.
+- ``MINOR``: Backwards-compatible new features and enhancements.
+- ``PATCH``: Backwards-compatible bugfixes and package updates.
+
+## Contributing
+
+This is an active open-source project. We are always open to people who want to
+use the code or contribute to it.
+
+We've set up a separate document for our
+[contribution guidelines](.github/CONTRIBUTING.md).
+
+Thank you for being involved! :heart_eyes:
+
+## Setting up development environment
+
+This Python project is fully managed using the [Poetry][poetry] dependency manager. But also relies on the use of NodeJS for certain checks during development.
+
+You need at least:
+
+- Python 3.11+
+- [Poetry][poetry-install]
+- NodeJS 12+ (including NPM)
+
+To install all packages, including all development requirements:
+
+```bash
+npm install
+poetry install
+```
+
+As this repository uses the [pre-commit][pre-commit] framework, all changes
+are linted and tested with each commit. You can run all checks and tests
+manually, using the following command:
+
+```bash
+poetry run pre-commit run --all-files
+```
+
+To run just the Python tests:
+
+```bash
+poetry run pytest
+```
+
+## Authors & contributors
+
+The content is by [Joost Lekkerkerker][joostlek].
+
+For a full list of all authors and contributors,
+check [the contributor's page][contributors].
+
+## License
+
+MIT License
+
+Copyright (c) 2025 Joost Lekkerkerker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+[build-shield]: https://github.com/joostlek/python-open-router/actions/workflows/tests.yaml/badge.svg
+[build]: https://github.com/joostlek/python-open-router/actions
+[codecov-shield]: https://codecov.io/gh/joostlek/python-open-router/branch/master/graph/badge.svg
+[codecov]: https://codecov.io/gh/joostlek/python-open-router
+[commits-shield]: https://img.shields.io/github/commit-activity/y/joostlek/python-open-router.svg
+[commits]: https://github.com/joostlek/python-open-router/commits/master
+[contributors]: https://github.com/joostlek/python-open-router/graphs/contributors
+[joostlek]: https://github.com/joostlek
+[keepchangelog]: http://keepachangelog.com/en/1.0.0/
+[license-shield]: https://img.shields.io/github/license/joostlek/python-open-router.svg
+[maintenance-shield]: https://img.shields.io/maintenance/yes/2025.svg
+[poetry-install]: https://python-poetry.org/docs/#installation
+[poetry]: https://python-poetry.org
+[pre-commit]: https://pre-commit.com/
+[project-stage-shield]: https://img.shields.io/badge/project%20stage-stable-green.svg
+[python-versions-shield]: https://img.shields.io/pypi/pyversions/python-open-router
+[releases-shield]: https://img.shields.io/github/release/joostlek/python-open-router.svg
+[releases]: https://github.com/joostlek/python-open-router/releases
+[semver]: http://semver.org/spec/v2.0.0.html
+[pypi]: https://pypi.org/project/python-open-router/
+

python_open_router-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+python_open_router/__init__.py,sha256=qWLg-1XHDTgXR7AGOzVjxQ2amINWgwTnMrRe77WFRXw,376
+python_open_router/exceptions.py,sha256=68nskqNdXNMIK4iA1XOE1E5P5rbhAf27DDACkk-ZVwU,312
+python_open_router/models.py,sha256=z-SMl13PAGRyQ_83zXlU7US0teNqxfc4ArTm0ain-zs,478
+python_open_router/open_router.py,sha256=mVcNVZcSEcD5csllZes3RlKa7ReWEQXJf625M-so6Mo,3292
+python_open_router/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+python_open_router-0.1.0.dist-info/LICENSE.md,sha256=Xbw7n2Ic30r4j8_MDNND4ss_sdoj9IGeIkEWc2Hsfs8,1077
+python_open_router-0.1.0.dist-info/METADATA,sha256=KFnz6IFqokjCanKGMC6GmT3hzA53fdjc2JdinQU7OH4,6030
+python_open_router-0.1.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+python_open_router-0.1.0.dist-info/RECORD,,

python_open_router-0.1.0.dist-info/WHEEL

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