gemini-gateway 0.1.0__tar.gz

gemini_gateway-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://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. (Do not 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 2026 NickZaitsev
+
+   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
+
+       https://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.

gemini_gateway-0.1.0/PKG-INFO

@@ -0,0 +1,365 @@
+Metadata-Version: 2.4
+Name: gemini-gateway
+Version: 0.1.0
+Summary: Shared Google Gemini API gateway with multi-key rate limiting and retries.
+Author-email: NickZaitsev <nekitlomic@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/NickZaitsev/gemini-gateway
+Project-URL: Repository, https://github.com/NickZaitsev/gemini-gateway
+Project-URL: Issues, https://github.com/NickZaitsev/gemini-gateway/issues
+Keywords: gemini,google-genai,rate-limit,llm,api-gateway
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: google-genai>=1.30.0
+Requires-Dist: pydantic>=2.8.0
+Requires-Dist: python-dotenv>=1.0.1
+Provides-Extra: dev
+Requires-Dist: build>=1.2.2; extra == "dev"
+Requires-Dist: pytest>=8.3.2; extra == "dev"
+Requires-Dist: ruff>=0.8.0; extra == "dev"
+Requires-Dist: mypy>=1.13.0; extra == "dev"
+Requires-Dist: twine>=5.1.1; extra == "dev"
+Dynamic: license-file
+
+# gemini-gateway
+
+[![CI](https://github.com/NickZaitsev/gemini-gateway/actions/workflows/ci.yml/badge.svg)](https://github.com/NickZaitsev/gemini-gateway/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/gemini-gateway.svg)](https://pypi.org/project/gemini-gateway/)
+[![Python](https://img.shields.io/pypi/pyversions/gemini-gateway.svg)](https://pypi.org/project/gemini-gateway/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+A small, dependency-light Python gateway for the Google Gemini API that adds the
+production concerns you usually end up writing yourself: **multi-key rotation,
+client-side rate limiting, bounded retries, error classification, and typed
+structured output** — behind a tiny, stable API.
+
+It is deliberately scoped to reusable API plumbing. It contains no
+application-specific logic, so the same gateway can be shared across projects by
+giving each one its own environment-variable prefix.
+
+---
+
+## Table of contents
+
+- [Why](#why)
+- [Features](#features)
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Quick start](#quick-start)
+- [Structured JSON output](#structured-json-output)
+- [Result metadata](#result-metadata)
+- [Configuration](#configuration)
+  - [Environment variables](#environment-variables)
+  - [Per-project prefixes](#per-project-prefixes)
+  - [Configuring in code](#configuring-in-code)
+- [How rate limiting works](#how-rate-limiting-works)
+- [Retries and error handling](#retries-and-error-handling)
+- [Testing your own code](#testing-your-own-code)
+- [Public API](#public-api)
+- [Development](#development)
+- [License](#license)
+
+---
+
+## Why
+
+Calling Gemini directly works until it doesn't: a key hits its per-minute quota,
+the backend returns a transient `503`, or you want JSON back as a validated
+object instead of a string you have to parse by hand. `gemini-gateway` wraps the
+official [`google-genai`](https://pypi.org/project/google-genai/) client and
+handles those cases consistently, without leaking provider details into your
+application code.
+
+## Features
+
+- **Multi-key rotation** — supply several API keys; requests are spread across
+  them and a key is automatically skipped while it is cooling down or disabled.
+- **Client-side rate limiting** — enforces requests-per-minute (RPM),
+  tokens-per-minute (TPM), and requests-per-day (RPD) limits *before* sending,
+  so you stay under quota instead of reacting to `429`s.
+- **Bounded retries with backoff** — transient failures are retried with
+  exponential backoff and honor the API's `retryDelay` hint when present. Retry
+  counts are bounded by default; unbounded retries on capacity errors are strict
+  opt-in.
+- **Error classification** — exceptions are categorized (`rate_limit`,
+  `network`, `server`, `auth`, `validation`, `internal`, `unknown`) using
+  structured status codes first, with message-text fallback.
+- **Typed structured output** — pass a Pydantic model and get a validated
+  instance back.
+- **Usage metadata** — optional result objects expose input/output token counts,
+  the model used, and which key served the request.
+- **Testable by design** — the network client, clock, and sleep function are all
+  injectable, so your tests never touch the real API.
+
+## Requirements
+
+- Python **3.10+**
+- A Google Gemini API key ([get one here](https://aistudio.google.com/apikey))
+
+## Installation
+
+```bash
+pip install gemini-gateway
+```
+
+## Quick start
+
+```python
+from gemini_gateway import GeminiGateway
+
+# Reads GEMINI_API_KEY / GEMINI_API_KEYS (and other GEMINI_* vars) from the
+# environment or a local .env file.
+gateway = GeminiGateway.from_env()
+
+text = gateway.generate_text("Write a one-sentence product tagline for a coffee shop.")
+print(text)
+```
+
+The minimum configuration is a single API key:
+
+```bash
+export GEMINI_API_KEY="your-key"
+```
+
+## Structured JSON output
+
+Pass a Pydantic model and receive a validated instance. The gateway requests
+JSON from Gemini using the model as the response schema and validates the result
+for you.
+
+```python
+from pydantic import BaseModel
+from gemini_gateway import GeminiGateway
+
+
+class Product(BaseModel):
+    name: str
+    tagline: str
+    price_usd: float
+
+
+gateway = GeminiGateway.from_env()
+
+product = gateway.generate_json(
+    "Invent a fictional coffee product as JSON with name, tagline, price_usd.",
+    Product,
+    max_output_tokens=512,
+)
+
+print(product.name, product.price_usd)  # fully typed
+```
+
+If Gemini returns malformed or non-conforming JSON, a Pydantic
+`ValidationError` (a subclass of `ValueError`) is raised.
+
+## Result metadata
+
+Use the `*_result` variants when you need token usage, the model name, or which
+key served the request (useful for logging and cost tracking).
+
+```python
+result = gateway.generate_text_result("Summarize the theory of relativity.")
+
+print(result.text)
+print(result.usage.input_tokens, result.usage.output_tokens)
+print(result.model)          # e.g. "gemini-2.0-flash"
+print(result.api_key_label)  # e.g. "key-2"
+```
+
+`generate_json_result(...)` returns the same metadata with a validated
+`payload` field instead of `text`.
+
+## Configuration
+
+### Environment variables
+
+All variables are prefixed (default prefix: `GEMINI`). Only an API key is
+required; everything else has a sensible default.
+
+| Variable (with prefix)                | Default            | Description                                                        |
+| ------------------------------------- | ------------------ | ------------------------------------------------------------------ |
+| `_API_KEYS`                           | —                  | Comma/newline/semicolon-separated list of keys.                    |
+| `_API_KEY`                            | —                  | Single key (used if `_API_KEYS` is unset).                         |
+| `_MODEL`                              | `gemini-2.0-flash` | Model name.                                                        |
+| `_RPM`                                | `15`               | Max requests per minute, per key.                                  |
+| `_TPM`                                | `250000`           | Max tokens per minute, per key.                                    |
+| `_RPD`                                | `500`              | Max requests per day, per key (rolling 24h window).                |
+| `_TIMEOUT_MS`                         | `120000`           | Per-request HTTP timeout, in milliseconds.                         |
+| `_MAX_RETRIES`                        | `3`                | Max attempts for retryable errors.                                 |
+| `_MAX_OUTPUT_TOKENS`                  | `2048`             | Default output token cap (overridable per call).                   |
+| `_TEMPERATURE`                        | `0.2`              | Sampling temperature (0–2).                                        |
+| `_RETRY_BASE_SECONDS`                 | `5.0`              | Base delay for exponential backoff.                                |
+| `_RETRY_MAX_SECONDS`                  | `60.0`             | Maximum backoff delay.                                             |
+| `_DEFAULT_COOLDOWN_SECONDS`           | `5.0`              | Cooldown applied to a key after a limit/error with no hint.        |
+| `_RETRY_CAPACITY_ERRORS_INDEFINITELY` | `false`            | If `true`, retry capacity (overload) errors without a retry limit. |
+
+Example `.env` (see [`.env.example`](.env.example)):
+
+```env
+GEMINI_API_KEYS=key1,key2,key3
+GEMINI_MODEL=gemini-2.0-flash
+GEMINI_RPM=15
+GEMINI_TPM=250000
+GEMINI_RPD=500
+GEMINI_MAX_OUTPUT_TOKENS=2048
+```
+
+> `GeminiGatewayConfig.from_env()` calls `load_dotenv()` by default, which reads
+> a `.env` file into `os.environ`. Pass `load_dotenv_file=False` if you need
+> strict control over the environment.
+
+### Per-project prefixes
+
+Because the gateway is meant to be shared, each project can isolate its
+configuration with a custom prefix:
+
+```python
+from gemini_gateway import GeminiGateway, GeminiGatewayConfig
+
+config = GeminiGatewayConfig.from_env(prefix="PUBLISHER_GEMINI")
+gateway = GeminiGateway(config)
+```
+
+This reads `PUBLISHER_GEMINI_API_KEYS`, `PUBLISHER_GEMINI_MODEL`, and so on.
+
+### Configuring in code
+
+You can skip the environment entirely and build a config directly. Invalid
+values are rejected at construction time with a clear `ValueError`.
+
+```python
+from gemini_gateway import GeminiGateway, GeminiGatewayConfig
+
+config = GeminiGatewayConfig(
+    model="gemini-2.0-flash",
+    api_keys=("key1", "key2"),
+    requests_per_minute=10,
+    tokens_per_minute=200_000,
+    requests_per_day=400,
+)
+gateway = GeminiGateway(config)
+```
+
+## How rate limiting works
+
+Limits are enforced **per key** by `MultiKeyRateLimiter` before a request is
+sent. On each call the limiter picks the next eligible key in round-robin order,
+skipping any key that is disabled, cooling down, or would exceed its RPM, TPM, or
+RPD window. If every key is momentarily unavailable, the limiter sleeps until the
+soonest one frees up rather than overshooting quota.
+
+Token accounting uses an estimate of `prompt_length / 4 + max_output_tokens`
+when you don't pass an explicit `token_budget`. RPD is tracked as a rolling
+24-hour window — an API-safe approximation, not a calendar-day reset at the
+provider's midnight.
+
+## Retries and error handling
+
+Each failed attempt is classified by `classify_api_error`:
+
+| Category     | Retryable | Notes                                                          |
+| ------------ | --------- | -------------------------------------------------------------- |
+| `rate_limit` | yes       | Triggers a key cooldown; honors `retryDelay` hints.            |
+| `network`    | yes       | Connection/timeout/TLS errors.                                 |
+| `server`     | yes       | `5xx` / overload. Capacity errors are retryable indefinitely only when opted in. |
+| `auth`       | no        | Disables the key and rotates to the next available one.        |
+| `validation` | no        | Bad/empty/invalid output; raised to the caller.               |
+| `internal`   | no        | Programming errors (`TypeError`, `KeyError`, …).               |
+| `unknown`    | yes       | Conservatively retried.                                        |
+
+Retries use exponential backoff (`retry_base_delay_seconds * 2**attempt`, capped
+at `retry_max_delay_seconds`) and respect any server-provided delay hint. When
+all retries are exhausted, a `GeminiRetriesExhaustedError` is raised with the
+last underlying exception chained.
+
+```python
+from gemini_gateway import GeminiGateway, GeminiRetriesExhaustedError, NoApiKeysError
+
+try:
+    gateway = GeminiGateway.from_env()
+    text = gateway.generate_text("Hello!")
+except NoApiKeysError:
+    ...  # no keys configured
+except GeminiRetriesExhaustedError as exc:
+    ...  # transient failures persisted past max_retries; exc.__cause__ has details
+```
+
+## Testing your own code
+
+The network client, clock, and sleep function are injectable, so you can drive
+the gateway deterministically without any network access:
+
+```python
+from types import SimpleNamespace
+from gemini_gateway import GeminiGateway, GeminiGatewayConfig
+
+
+class FakeModels:
+    def generate_content(self, **kwargs):
+        return SimpleNamespace(text="stubbed", usage_metadata=None)
+
+
+class FakeClient:
+    models = FakeModels()
+
+
+config = GeminiGatewayConfig(model="gemini-test", api_keys=("k",))
+gateway = GeminiGateway(
+    config,
+    client_factory=lambda api_key, timeout_ms: FakeClient(),
+    sleep_fn=lambda _seconds: None,  # no real waiting
+)
+
+assert gateway.generate_text("hi") == "stubbed"
+```
+
+## Public API
+
+Everything below is exported from the top-level `gemini_gateway` package.
+
+**Entry points**
+
+- `GeminiGateway` — `from_env(prefix="GEMINI")`, `generate_text`,
+  `generate_text_result`, `generate_json`, `generate_json_result`
+- `GeminiGatewayConfig` — `from_env(prefix=..., env=..., load_dotenv_file=...)`
+
+**Result types**
+
+- `GeminiTextResult`, `GeminiJsonResult`, `GeminiUsage`
+
+**Rate limiting**
+
+- `MultiKeyRateLimiter`, `KeyState`
+
+**Errors & classification**
+
+- `classify_api_error`, `ApiErrorInfo`
+- `GeminiGatewayError` (base), `NoApiKeysError`, `GeminiRetriesExhaustedError`
+
+The package ships a `py.typed` marker, so type checkers see the annotations.
+
+## Development
+
+```bash
+python -m pip install -e ".[dev]"
+python -m ruff check .
+python -m ruff format --check .
+python -m mypy src
+python -m pytest
+python -m build
+python -m twine check dist/*
+```
+
+Tests use fake clients and never call the real Gemini API. Contributions should
+keep the public API small and typed, and avoid adding application-specific logic.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).