tierproxy 0.1.0__py3-none-any.whl

tierproxy/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

tierproxy/NOTICE

@@ -0,0 +1,17 @@
+tierproxy Python SDK
+Copyright 2026 TierProxy
+
+This product includes software developed by TierProxy and its contributors.
+
+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.
+
+Trademarks: "TierProxy" and "tierproxy" are trademarks of TierProxy.
+Use of these names in derivative works requires written permission.

tierproxy/__init__.py

@@ -0,0 +1,60 @@
+from typing import Any
+
+from tierproxy._module_api import get, post, request, reset_default_client, session
+from tierproxy._version import __version__
+from tierproxy.async_client import AsyncTierProxy
+from tierproxy.client import TierProxy
+from tierproxy.errors import (
+    AuthenticationError,
+    ConflictError,
+    ConnectionError,  # noqa: A004
+    TierProxyError,
+    NotFoundError,
+    PermissionError,  # noqa: A004
+    RateLimitError,
+    ServerError,
+    TimeoutError,  # noqa: A004
+    ValidationError,
+)
+from tierproxy.proxy.url_builder import ProxyURL
+from tierproxy.resources.health import UpstreamHealth
+from tierproxy.resources.me import Me
+from tierproxy.resources.usage import Usage, UsageDay, UsageDelta
+from tierproxy.retry import RetryPolicy
+
+
+def enable_telemetry(**kwargs: Any) -> None:
+    """Lazy proxy to tierproxy._otel.enable_telemetry — keeps OTel import optional."""
+    from tierproxy._otel import enable_telemetry as _enable
+
+    _enable(**kwargs)
+
+
+__all__ = [
+    "AsyncTierProxy",
+    "AuthenticationError",
+    "ConflictError",
+    "ConnectionError",
+    "TierProxy",
+    "TierProxyError",
+    "Me",
+    "NotFoundError",
+    "PermissionError",
+    "ProxyURL",
+    "RateLimitError",
+    "RetryPolicy",
+    "ServerError",
+    "TimeoutError",
+    "Usage",
+    "UsageDay",
+    "UsageDelta",
+    "UpstreamHealth",
+    "ValidationError",
+    "__version__",
+    "enable_telemetry",
+    "get",
+    "post",
+    "request",
+    "reset_default_client",
+    "session",
+]

tierproxy/_cli.py

@@ -0,0 +1,84 @@
+"""`tierproxy` CLI - minimum-viable for users who want curl-style ergonomics.
+
+Usage:
+    tierproxy doctor                       # verify auth + show health snapshot
+    tierproxy get <url> --country US       # fetch + print body
+    tierproxy usage                        # current month usage + cost
+"""
+
+from __future__ import annotations
+
+import argparse
+import sys
+
+
+def cmd_doctor(args: argparse.Namespace) -> int:
+    from tierproxy import TierProxy
+
+    g = TierProxy(api_key=args.api_key)
+    me = g.me.get()
+    print(
+        f"OK Auth - client {me.client_id} ({me.plan_id}), "
+        f"{me.used_bytes_month:,}/{me.quota_bytes_month:,} bytes used"
+    )
+    ups = g.health.upstreams()
+    print(f"OK Upstreams ({len(ups)}):")
+    for u in ups:
+        print(
+            f"  - {u.upstream_id:14} state={u.state}  cb={u.cb_state}  "
+            f"sr={u.success_rate:.1%}  p95={u.latency_p95_ms}ms  "
+            f"${u.cost_per_gb_usd}/GB"
+        )
+    return 0
+
+
+def cmd_get(args: argparse.Namespace) -> int:
+    from tierproxy import TierProxy
+
+    g = TierProxy(api_key=args.api_key)
+    kwargs: dict[str, str] = {}
+    if args.country:
+        kwargs["country"] = args.country
+    if args.session_id:
+        kwargs["session_id"] = args.session_id
+    r = g.get(args.url, **kwargs)
+    sys.stdout.write(r.text)
+    return 0 if 200 <= r.status_code < 300 else 1
+
+
+def cmd_usage(args: argparse.Namespace) -> int:
+    from tierproxy import TierProxy
+
+    g = TierProxy(api_key=args.api_key)
+    u = g.usage.get()
+    print(f"Period: {u.from_} -> {u.to}")
+    print(f"Total: {u.total_bytes:,} bytes  /  ${u.total_cost_usd:.2f}")
+    for d in u.days:
+        print(f"  {d.date}  up={d.bytes_up:,}  down={d.bytes_down:,}  ${d.cost_usd:.4f}")
+    return 0
+
+
+def main(argv: list[str] | None = None) -> int:
+    p = argparse.ArgumentParser(prog="tierproxy")
+    p.add_argument("--api-key", help="defaults to TIERPROXY_API_KEY env var")
+    sub = p.add_subparsers(dest="cmd", required=True)
+
+    sub.add_parser("doctor", help="verify auth + show upstream health").set_defaults(
+        func=cmd_doctor
+    )
+
+    g = sub.add_parser("get", help="HTTP GET through the gateway")
+    g.add_argument("url")
+    g.add_argument("--country")
+    g.add_argument("--session-id")
+    g.set_defaults(func=cmd_get)
+
+    sub.add_parser("usage", help="show current-month usage + cost").set_defaults(func=cmd_usage)
+
+    args = p.parse_args(argv)
+    func = args.func
+    return int(func(args))
+
+
+if __name__ == "__main__":
+    sys.exit(main())

tierproxy/_guard.py

@@ -0,0 +1,23 @@
+"""Cost / usage guardrails used by TierProxy when monthly_budget_usd or
+on_usage_pct is configured. Keeps the heavy logic out of client.py."""
+
+from __future__ import annotations
+
+from tierproxy.errors import TierProxyError
+
+
+class BudgetExceededError(TierProxyError):
+    """Raised when an inbound request would push monthly cost over the configured budget."""
+
+
+def check_budget(
+    estimated_cost_usd: float,
+    spent_usd: float,
+    monthly_budget_usd: float,
+) -> None:
+    if spent_usd + estimated_cost_usd > monthly_budget_usd:
+        raise BudgetExceededError(
+            f"Refusing request: estimated cost ${estimated_cost_usd:.4f} would push "
+            f"month-to-date spend (${spent_usd:.2f}) over monthly_budget_usd "
+            f"(${monthly_budget_usd:.2f})",
+        )

tierproxy/_internal/http.py

@@ -0,0 +1,146 @@
+"""Shared httpx-based transport. Both sync and async clients call into this."""
+
+from __future__ import annotations
+
+import asyncio
+import logging
+import time
+from typing import Any, cast
+
+import httpx
+
+from tierproxy._version import __version__
+from tierproxy.errors import (
+    ConnectionError as GwConnectionError,
+)
+from tierproxy.errors import (
+    TimeoutError as GwTimeoutError,
+)
+from tierproxy.errors import (
+    from_problem,
+)
+from tierproxy.retry import RetryPolicy
+
+log = logging.getLogger("tierproxy")
+_DEFAULT_UA = f"tierproxy-python/{__version__} httpx/{httpx.__version__}"
+
+
+class Transport:
+    """Backs both TierProxy and AsyncTierProxy."""
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str,
+        timeout: float,
+        retry: RetryPolicy,
+        ua_suffix: str | None,
+        http_client: httpx.Client | httpx.AsyncClient | None,
+        is_async: bool,
+    ) -> None:
+        self.api_key = api_key
+        self.base_url = base_url.rstrip("/")
+        self.retry = retry
+        self.ua = f"{_DEFAULT_UA} {ua_suffix}".strip() if ua_suffix else _DEFAULT_UA
+        self._is_async = is_async
+        self._client: httpx.Client | httpx.AsyncClient
+        if http_client is not None:
+            self._client = http_client
+        elif is_async:
+            self._client = httpx.AsyncClient(timeout=timeout)
+        else:
+            self._client = httpx.Client(timeout=timeout)
+
+    def _headers(self) -> dict[str, str]:
+        return {
+            "Authorization": f"Bearer {self.api_key}",
+            "User-Agent": self.ua,
+            "Accept": "application/json",
+        }
+
+    def request(self, method: str, path: str, **kwargs: Any) -> dict[str, Any]:
+        assert not self._is_async
+        return self._dispatch_sync(method, path, **kwargs)
+
+    async def arequest(self, method: str, path: str, **kwargs: Any) -> dict[str, Any]:
+        assert self._is_async
+        return await self._dispatch_async(method, path, **kwargs)
+
+    def _dispatch_sync(self, method: str, path: str, **kwargs: Any) -> dict[str, Any]:
+        client = cast(httpx.Client, self._client)
+        attempt = 0
+        while True:
+            try:
+                resp = client.request(
+                    method,
+                    self.base_url + path,
+                    headers=self._headers(),
+                    **kwargs,
+                )
+            except (httpx.ConnectError, httpx.NetworkError) as e:
+                if self.retry.should_retry(attempt, method, None, True, True):
+                    time.sleep(self.retry.delay(attempt))
+                    attempt += 1
+                    continue
+                raise GwConnectionError(str(e)) from e
+            except httpx.TimeoutException as e:
+                if self.retry.should_retry(attempt, method, 408, False, True):
+                    time.sleep(self.retry.delay(attempt))
+                    attempt += 1
+                    continue
+                raise GwTimeoutError(str(e)) from e
+            if 200 <= resp.status_code < 300:
+                if resp.headers.get("Content-Type", "").startswith("text/event-stream"):
+                    return {"_sse_response": resp}
+                return cast(dict[str, Any], resp.json()) if resp.content else {}
+            if self.retry.should_retry(attempt, method, resp.status_code, False, True):
+                retry_after = float(resp.headers.get("Retry-After", "0")) or None
+                time.sleep(self.retry.delay(attempt, retry_after))
+                attempt += 1
+                continue
+            self._raise_for(resp)
+
+    async def _dispatch_async(self, method: str, path: str, **kwargs: Any) -> dict[str, Any]:
+        client = cast(httpx.AsyncClient, self._client)
+        attempt = 0
+        while True:
+            try:
+                resp = await client.request(
+                    method,
+                    self.base_url + path,
+                    headers=self._headers(),
+                    **kwargs,
+                )
+            except (httpx.ConnectError, httpx.NetworkError) as e:
+                if self.retry.should_retry(attempt, method, None, True, True):
+                    await asyncio.sleep(self.retry.delay(attempt))
+                    attempt += 1
+                    continue
+                raise GwConnectionError(str(e)) from e
+            except httpx.TimeoutException as e:
+                if self.retry.should_retry(attempt, method, 408, False, True):
+                    await asyncio.sleep(self.retry.delay(attempt))
+                    attempt += 1
+                    continue
+                raise GwTimeoutError(str(e)) from e
+            if 200 <= resp.status_code < 300:
+                if resp.headers.get("Content-Type", "").startswith("text/event-stream"):
+                    return {"_sse_response": resp}
+                return cast(dict[str, Any], resp.json()) if resp.content else {}
+            if self.retry.should_retry(attempt, method, resp.status_code, False, True):
+                retry_after = float(resp.headers.get("Retry-After", "0")) or None
+                await asyncio.sleep(self.retry.delay(attempt, retry_after))
+                attempt += 1
+                continue
+            self._raise_for(resp)
+
+    @staticmethod
+    def _raise_for(resp: httpx.Response) -> None:
+        try:
+            problem = resp.json()
+        except Exception:  # noqa: BLE001
+            problem = {
+                "title": resp.text or "error",
+                "request_id": resp.headers.get("X-Request-Id"),
+            }
+        raise from_problem(resp.status_code, problem)

tierproxy/_internal/sse.py

@@ -0,0 +1,71 @@
+"""Minimal Server-Sent Events parser. Yields dataclasses, no buffering hell."""
+
+from __future__ import annotations
+
+from collections.abc import AsyncIterator, Iterator
+from dataclasses import dataclass
+from typing import Any, cast
+
+import httpx
+
+
+@dataclass
+class SSEEvent:
+    event: str
+    data: str
+    id: str | None = None
+
+
+def _flush(state: dict[str, Any]) -> SSEEvent | None:
+    data_lines = cast(list[str], state.get("data") or [])
+    if not data_lines:
+        return None
+    return SSEEvent(
+        event=cast(str, state.get("event") or "message"),
+        data="\n".join(data_lines),
+        id=cast("str | None", state.get("id")),
+    )
+
+
+def iter_sse(resp: httpx.Response) -> Iterator[SSEEvent]:
+    state: dict[str, Any] = {"data": []}
+    for raw in resp.iter_lines():
+        if raw == "":
+            ev = _flush(state)
+            if ev:
+                yield ev
+            state = {"data": []}
+            continue
+        if raw.startswith(":"):
+            continue
+        if ":" in raw:
+            field, _, value = raw.partition(":")
+            value = value.lstrip(" ")
+        else:
+            field, value = raw, ""
+        if field == "data":
+            state.setdefault("data", []).append(value)
+        elif field in {"event", "id"}:
+            state[field] = value
+
+
+async def aiter_sse(resp: httpx.Response) -> AsyncIterator[SSEEvent]:
+    state: dict[str, Any] = {"data": []}
+    async for raw in resp.aiter_lines():
+        if raw == "":
+            ev = _flush(state)
+            if ev:
+                yield ev
+            state = {"data": []}
+            continue
+        if raw.startswith(":"):
+            continue
+        if ":" in raw:
+            field, _, value = raw.partition(":")
+            value = value.lstrip(" ")
+        else:
+            field, value = raw, ""
+        if field == "data":
+            state.setdefault("data", []).append(value)
+        elif field in {"event", "id"}:
+            state[field] = value

tierproxy/_module_api.py

@@ -0,0 +1,47 @@
+"""Module-level requests-style helpers backed by a lazy singleton TierProxy."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+import httpx
+
+if TYPE_CHECKING:
+    from tierproxy.client import TierProxy
+
+_default_client: TierProxy | None = None
+
+
+def _client() -> TierProxy:
+    global _default_client
+    if _default_client is None:
+        from tierproxy.client import TierProxy
+
+        _default_client = TierProxy()
+    return _default_client
+
+
+def get(url: str, **kwargs: Any) -> httpx.Response:
+    """Module-level GET through the gateway. Forwards targeting kwargs to ProxyURL."""
+    return _client().get(url, **kwargs)
+
+
+def post(url: str, **kwargs: Any) -> httpx.Response:
+    return _client().post(url, **kwargs)
+
+
+def request(method: str, url: str, **kwargs: Any) -> httpx.Response:
+    return _client().request(method, url, **kwargs)
+
+
+def session(**kwargs: Any) -> httpx.Client:
+    """Return an httpx.Client preconfigured to route through the gateway with the given targeting."""
+    return _client().session(**kwargs)
+
+
+def reset_default_client() -> None:
+    """For tests: drop the singleton so the next call rebuilds it."""
+    global _default_client
+    if _default_client is not None:
+        _default_client.close()
+        _default_client = None