xlkitlearn-api 0.0.1__py3-none-any.whl

xlkitlearn_api/__init__.py

@@ -0,0 +1,327 @@
+import json
+import typing
+import urllib.parse
+
+import requests
+
+
+__all__ = ["APIGateway"]
+
+
+class APIGateway:
+    """
+    Synchronous Python client for the XLKit Learn API.
+
+    Parameters
+    ----------
+    api_key:
+        API key sent as an Authorization bearer token.
+    base_url:
+        Base API URL. Defaults to the production XLKit Learn API.
+    timeout:
+        Request timeout in seconds.
+    """
+
+    DEFAULT_BASE_URL = "https://server.xlkitlearn.com/api"
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str = DEFAULT_BASE_URL,
+        timeout: float = 60.0,
+    ):
+        self.api_key = api_key
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+
+    @property
+    def _auth_headers(self) -> dict[str, str]:
+        api_key = self.api_key.strip()
+        if api_key.lower().startswith("bearer "):
+            return {"Authorization": api_key}
+        return {"Authorization": f"Bearer {api_key}"}
+
+    def _url(self, path: str) -> str:
+        return f"{self.base_url}/{path.lstrip('/')}"
+
+    def _request(self, method: str, path: str, **kwargs: typing.Any) -> typing.Any:
+        headers = dict(self._auth_headers)
+        headers.update(kwargs.pop("headers", {}) or {})
+
+        response = requests.request(
+            method,
+            self._url(path),
+            headers=headers,
+            timeout=self.timeout,
+            **kwargs,
+        )
+        return self._decode_response(response)
+
+    def _get(self, path: str) -> typing.Any:
+        return self._request("GET", path)
+
+    def _post(self, path: str, payload: dict[str, typing.Any]) -> typing.Any:
+        return self._request("POST", path, json=self._without_none(payload))
+
+    def _post_sse(self, path: str, payload: dict[str, typing.Any]) -> typing.Any:
+        response = requests.post(
+            self._url(path),
+            headers=self._auth_headers,
+            json=self._without_none(payload),
+            timeout=self.timeout,
+        )
+        self._raise_for_status(response)
+
+        events = self._parse_sse(response.text)
+        for event, data in events:
+            if event == "error":
+                raise RuntimeError(str(data))
+            if event == "sent":
+                return data
+
+        return events[-1][1] if events else None
+
+    def _decode_response(self, response: requests.Response) -> typing.Any:
+        self._raise_for_status(response)
+        if not response.content:
+            return None
+
+        content_type = response.headers.get("content-type", "")
+        if "application/json" in content_type:
+            return response.json()
+
+        try:
+            return response.json()
+        except ValueError:
+            return response.text
+
+    def _raise_for_status(self, response: requests.Response) -> None:
+        if response.status_code < 400:
+            return
+
+        detail: typing.Any
+        try:
+            payload = response.json()
+            detail = payload.get("detail", payload) if isinstance(payload, dict) else payload
+        except ValueError:
+            detail = response.text
+
+        message = f"{response.status_code} error for {response.request.method} {response.url}: {detail}"
+        raise requests.HTTPError(message, response=response)
+
+    @staticmethod
+    def _without_none(payload: dict[str, typing.Any]) -> dict[str, typing.Any]:
+        return {key: value for key, value in payload.items() if value is not None}
+
+    @staticmethod
+    def _quote_path(value: str) -> str:
+        return urllib.parse.quote(str(value), safe="")
+
+    @staticmethod
+    def _parse_sse(text: str) -> list[tuple[str | None, typing.Any]]:
+        events: list[tuple[str | None, typing.Any]] = []
+        event: str | None = None
+        data_lines: list[str] = []
+
+        for line in text.splitlines():
+            if line == "":
+                if event is not None or data_lines:
+                    raw_data = "\n".join(data_lines)
+                    try:
+                        data: typing.Any = json.loads(raw_data)
+                    except ValueError:
+                        data = raw_data
+                    events.append((event, data))
+                event = None
+                data_lines = []
+                continue
+
+            if line.startswith("event:"):
+                event = line[len("event:") :].strip()
+            elif line.startswith("data:"):
+                data_lines.append(line[len("data:") :].strip())
+
+        if event is not None or data_lines:
+            raw_data = "\n".join(data_lines)
+            try:
+                data = json.loads(raw_data)
+            except ValueError:
+                data = raw_data
+            events.append((event, data))
+
+        return events
+
+    def quotas(self) -> dict[str, typing.Any]:
+        """GET /quotas"""
+
+        return self._get("quotas")
+
+    def send_text(self, phone_number: str, message: str) -> dict[str, typing.Any]:
+        """
+        POST /send-text with wait_for_response disabled.
+
+        Returns the immediate sent event payload, usually {"text_id": "..."}.
+        """
+
+        return self._post_sse(
+            "send-text",
+            {
+                "phone_number": phone_number,
+                "message": message,
+                "wait_for_response": False,
+            },
+        )
+
+    def get_text_responses(self, text_id: str) -> list[str]:
+        """GET /send-text/responses/{text_id}"""
+
+        return self._get(f"send-text/responses/{self._quote_path(text_id)}")
+
+    def send_email(
+        self,
+        send_to_address: str,
+        email_subject: str = "(no subject)",
+        email_text: str = "(no message)",
+        thread_token: str | None = None,
+    ) -> dict[str, typing.Any]:
+        """
+        POST /send-email with wait_for_response disabled.
+
+        Returns the immediate sent event payload, usually
+        {"message_id": "...", "thread_token": "..."}.
+        """
+
+        return self._post_sse(
+            "send-email",
+            {
+                "send_to_address": send_to_address,
+                "email_subject": email_subject,
+                "email_text": email_text,
+                "wait_for_response": False,
+                "thread_token": thread_token,
+            },
+        )
+
+    def get_email_thread(self, thread_token: str) -> list[dict[str, typing.Any]]:
+        """GET /send-email/thread/{thread_token}"""
+
+        return self._get(f"send-email/thread/{self._quote_path(thread_token)}")
+
+    def maps_places_search(
+        self,
+        query: str,
+        restriction_place_id: str | None = None,
+        restriction_radius_meters: float | None = None,
+        included_type: str | None = None,
+        open_now: bool | None = None,
+    ) -> dict[str, typing.Any]:
+        """POST /maps/places/search"""
+
+        return self._post(
+            "maps/places/search",
+            {
+                "query": query,
+                "restriction_place_id": restriction_place_id,
+                "restriction_radius_meters": restriction_radius_meters,
+                "included_type": included_type,
+                "open_now": open_now,
+            },
+        )
+
+    def maps_routes_travel_time(
+        self,
+        origin_place_id: str,
+        destination_place_id: str,
+        travel_mode: str = "DRIVE",
+        consider_traffic: bool = False,
+        departure_time: str | None = None,
+        arrival_time: str | None = None,
+        units: str = "IMPERIAL",
+    ) -> dict[str, typing.Any]:
+        """POST /maps/routes/travel-time"""
+
+        return self._post(
+            "maps/routes/travel-time",
+            {
+                "origin_place_id": origin_place_id,
+                "destination_place_id": destination_place_id,
+                "travel_mode": travel_mode,
+                "consider_traffic": consider_traffic,
+                "departure_time": departure_time,
+                "arrival_time": arrival_time,
+                "units": units,
+            },
+        )
+
+    def maps_weather(
+        self,
+        latitude: float,
+        longitude: float,
+        units_system: str = "IMPERIAL",
+        forecast_until: str | None = None,
+    ) -> dict[str, typing.Any]:
+        """POST /maps/weather"""
+
+        return self._post(
+            "maps/weather",
+            {
+                "latitude": latitude,
+                "longitude": longitude,
+                "units_system": units_system,
+                "forecast_until": forecast_until,
+            },
+        )
+
+    def flight_availability(
+        self,
+        cabin_class: str,
+        allow_connection: bool,
+        legs: list[dict[str, typing.Any]],
+    ) -> dict[str, typing.Any]:
+        """POST /duffel/flight-availability"""
+
+        return self._post(
+            "duffel/flight-availability",
+            {
+                "cabin_class": cabin_class,
+                "allow_connection": allow_connection,
+                "legs": legs,
+            },
+        )
+
+    def flight_availability_next_leg(
+        self,
+        search_id: str,
+        previous_legs: str,
+    ) -> dict[str, typing.Any]:
+        """POST /duffel/flight-availability/next-leg"""
+
+        return self._post(
+            "duffel/flight-availability/next-leg",
+            {
+                "search_id": search_id,
+                "previous_legs": previous_legs,
+            },
+        )
+
+    def finance_daily_prices(
+        self,
+        tickers: list[str],
+        start: str,
+        end: str,
+    ) -> dict[str, list[dict[str, typing.Any]]]:
+        """POST /finance/daily-prices"""
+
+        return self._post(
+            "finance/daily-prices",
+            {
+                "tickers": tickers,
+                "start": start,
+                "end": end,
+            },
+        )
+
+    def ip_info(self) -> dict[str, typing.Any]:
+        """GET /ip_info"""
+
+        return self._get("ip_info")

xlkitlearn_api-0.0.1.dist-info/METADATA

@@ -0,0 +1,17 @@
+Metadata-Version: 2.4
+Name: xlkitlearn_api
+Version: 0.0.1
+Summary: A python client for XLKitLearn APIs
+Project-URL: Homepage, https://www.xlkitlearn.com
+Author-email: Daniel Guetta <daniel@guetta.com>
+License-Expression: MIT
+License-File: LICENSE.md
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: requests>=2.32.2
+Description-Content-Type: text/markdown
+
+# XLKitLearn API Client
+
+This package is a Python client for the APIs available with XLKitLearn. See [xlkitlearn.com](https://www.xlkitlearn.com).

xlkitlearn_api-0.0.1.dist-info/RECORD

@@ -0,0 +1,5 @@
+xlkitlearn_api/__init__.py,sha256=6Zx9ScXYgul7Bd3ZrKiThDHSjPPW5G_YhQIRTe8BE8E,9837
+xlkitlearn_api-0.0.1.dist-info/METADATA,sha256=Eep4VyQDenpthr_MOwwGDeYtU2lshoVmG0dRoRjhx7U,588
+xlkitlearn_api-0.0.1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+xlkitlearn_api-0.0.1.dist-info/licenses/LICENSE.md,sha256=3ZcKMvncXiY0Y4d6PnmJNT645rMNG5jRiJiJN9V1zcQ,1060
+xlkitlearn_api-0.0.1.dist-info/RECORD,,

xlkitlearn_api-0.0.1.dist-info/WHEEL

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

xlkitlearn_api-0.0.1.dist-info/licenses/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2026 Daniel Guetta
+
+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.