flintai-sdk-py 1.0.0__tar.gz

flintai_sdk_py-1.0.0/LICENSE

@@ -0,0 +1,181 @@
+                                 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 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, as submitted to the 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 recording and
+      discussing modifications to the Work, but excluding communication that
+      is conspicuously marked or designated in writing by the copyright owner
+      as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      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 the 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 any patent
+      claim embodied in 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, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, 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 in addition 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 license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the Work,
+      as an additional requirement beyond those described in Section 4.
+
+   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 reproducing 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 exemplary 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 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 offer only
+      conditions that are (1) consistent with the terms of this License,
+      and (2) do not impose restrictions on the granting of rights required
+      by this License.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 SB Technology, Inc. dba SandboxAQ
+
+   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.

flintai_sdk_py-1.0.0/PKG-INFO

@@ -0,0 +1,324 @@
+Metadata-Version: 2.4
+Name: flintai-sdk-py
+Version: 1.0.0
+Summary: Lightweight SDK for routing AI agent LLM traffic through the FlintAI guardrails proxy
+Author: SandboxAQ
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/sandbox-quantum/flintai-sdk-py
+Project-URL: Bug Tracker, https://github.com/sandbox-quantum/flintai-sdk-py/issues
+Keywords: ai,agents,guardrails
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+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
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: openai
+Requires-Dist: openai<3,>=2.40.0; extra == "openai"
+Provides-Extra: anthropic
+Requires-Dist: anthropic<1,>=0.105.2; extra == "anthropic"
+Provides-Extra: genai
+Requires-Dist: google-genai<3,>=2.7; extra == "genai"
+Provides-Extra: langchain
+Requires-Dist: langchain-openai<2,>=1.2; extra == "langchain"
+Requires-Dist: langchain-anthropic<2,>=1.4; extra == "langchain"
+Requires-Dist: langchain-google-genai<5,>=4.2; extra == "langchain"
+Provides-Extra: adk
+Requires-Dist: google-adk<3,>=2.1; extra == "adk"
+Requires-Dist: google-genai<3,>=2.7; extra == "adk"
+Provides-Extra: dotenv
+Requires-Dist: python-dotenv<2,>=1.2.2; extra == "dotenv"
+Provides-Extra: dev
+Requires-Dist: pytest>=9.0.3; extra == "dev"
+Requires-Dist: ruff>=0.15.15; extra == "dev"
+Requires-Dist: mypy>=2.1.0; extra == "dev"
+Provides-Extra: audit
+Requires-Dist: build>=1.0; extra == "audit"
+Requires-Dist: twine>=6.0; extra == "audit"
+Requires-Dist: pip-licenses>=5.0; extra == "audit"
+Requires-Dist: cyclonedx-bom>=6.0; extra == "audit"
+Requires-Dist: pip-audit>=2.7; extra == "audit"
+Requires-Dist: pip-tools>=7.4; extra == "audit"
+Provides-Extra: all
+Requires-Dist: flintai-sdk-py[adk,anthropic,audit,dev,dotenv,genai,langchain,openai]; extra == "all"
+Dynamic: license-file
+
+# FlintAI SDK (Python)
+
+Lightweight SDK for routing LLM traffic through a guardrails proxy. Wraps OpenAI, Anthropic, Google GenAI, and LangChain LLM clients, with agent framework plugins for Google ADK.
+
+## Features
+
+- **LLM SDK wrapping** — route LLM traffic through the FlintAI guardrails proxy with a single `flintai.wrap()` call. Supports OpenAI, Anthropic, Google GenAI, and LangChain chat models.
+- **Agent framework plugins** — deeper integration with agent lifecycle hooks for metadata extraction and guardrails routing. Currently supports Google ADK.
+- **Plugin system** for extensibility
+
+## Supported Integrations
+
+| Integration | Category | Guardrails Routing |
+|---|---|---|
+| OpenAI SDK | LLM SDK | `flintai.wrap()` |
+| Anthropic SDK | LLM SDK | `flintai.wrap()` |
+| Google GenAI SDK | LLM SDK | `flintai.wrap()` |
+| LangChain (`ChatOpenAI`, `ChatAnthropic`, `ChatGoogleGenerativeAI`) | LLM SDK | `flintai.wrap()` |
+| Google ADK | Agent Framework | `ADKGuardrailsPlugin` |
+
+## Install
+
+```bash
+pip install flintai-sdk-py
+
+# With optional extras for your LLM provider
+pip install "flintai-sdk-py[openai]"     # OpenAI SDK
+pip install "flintai-sdk-py[anthropic]"  # Anthropic SDK
+pip install "flintai-sdk-py[genai]"      # Google GenAI SDK
+pip install "flintai-sdk-py[adk]"        # Google ADK (includes GenAI)
+pip install "flintai-sdk-py[langchain]"  # LangChain integrations
+pip install "flintai-sdk-py[all]"        # Everything
+```
+
+## Guardrails
+
+Route all LLM traffic through the FlintAI guardrails proxy. Create your sync client as usual, then call `flintai.wrap()` — it auto-detects the provider and applies guardrails routing. Async clients (`AsyncOpenAI`, `AsyncAnthropic`) are not supported.
+
+### OpenAI
+
+```python
+import openai
+import flintai
+
+client = openai.OpenAI(api_key="your-openai-api-key")
+client = flintai.wrap(
+    client,
+    gateway_url="https://guardrails.example.com",
+    api_key="your-guardrails-api-key",
+    policy_id="your-policy-id",  # optional
+)
+
+response = client.chat.completions.create(
+    model="gpt-4",
+    messages=[{"role": "user", "content": "Hello"}],
+)
+```
+
+### Anthropic
+
+```python
+import anthropic
+import flintai
+
+client = anthropic.Anthropic(api_key="your-anthropic-api-key")
+client = flintai.wrap(
+    client,
+    gateway_url="https://guardrails.example.com",
+    api_key="your-guardrails-api-key",
+)
+
+message = client.messages.create(
+    model="claude-sonnet-4-20250514",
+    max_tokens=1024,
+    messages=[{"role": "user", "content": "Hello"}],
+)
+```
+
+### Google GenAI
+
+Google GenAI clients don't expose `api_key` as an attribute, so `llm_api_key` must be passed explicitly:
+
+```python
+import google.genai
+import flintai
+
+client = google.genai.Client(api_key="your-gemini-api-key")
+client = flintai.wrap(
+    client,
+    gateway_url="https://guardrails.example.com",
+    api_key="your-guardrails-api-key",
+    llm_api_key="your-gemini-api-key",
+)
+
+response = client.models.generate_content(
+    model="gemini-2.5-flash",
+    contents="Hello",
+)
+```
+
+### LangChain
+
+Create your LangChain chat model as usual, then call `flintai.wrap()` — it detects the LangChain model, finds the underlying SDK client, and applies guardrails routing:
+
+```python
+from langchain_openai import ChatOpenAI
+import flintai
+
+llm = ChatOpenAI(model="gpt-4", api_key="your-openai-api-key")
+llm = flintai.wrap(
+    llm,
+    gateway_url="https://guardrails.example.com",
+    api_key="your-guardrails-api-key",
+)
+
+response = llm.invoke("Hello")
+```
+
+Works with `ChatOpenAI`, `ChatAnthropic`, and `ChatGoogleGenerativeAI`.
+
+### Google ADK
+
+ADK agents lazily create their GenAI client at runtime and use `generate_content_config` for per-request routing, so `flintai.wrap()` cannot be used. Use the ADK plugin instead:
+
+```python
+from flintai.plugins.adk import ADKGuardrailsPlugin
+from google.adk import Agent
+
+plugin = ADKGuardrailsPlugin(
+    gateway_url="https://guardrails.example.com",
+    api_key="your-guardrails-api-key",
+    llm_api_key="your-gemini-api-key",
+)
+
+agent = Agent(
+    model="gemini-2.5-flash",
+    generate_content_config=plugin.content_config,
+    before_model_callback=plugin.before_model_callback,
+    on_model_error_callback=plugin.on_model_error,
+)
+```
+
+`before_model_callback` automatically extracts agent identity and session metadata on each LLM call — it reads the agent name from the ADK callback context and attaches `X-Agent-Id` and `X-Agent-Session-Id` headers to the guardrails request. It fails closed: if guardrails routing was never applied (the request has no `http_options`), it raises `FlintAIGuardrailsError` rather than sending an unguarded request — pass `require_guardrails=False` to the plugin for best-effort behavior. `on_model_error_callback` converts guardrails blocks (detected via the `GUARDRAIL_BLOCKED` error code) into an `LlmResponse` so the agent can handle them gracefully.
+
+## Configuration Reference
+
+`flintai.wrap()` and `flintai.init()` accept these guardrails parameters:
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `gateway_url` | `str` | Guardrails proxy URL |
+| `api_key` | `str` | Your guardrails API key |
+| `llm_api_key` | `str \| None` | Your upstream LLM provider API key, forwarded to the gateway as `X-LLM-API-Key`. Optional — by default the gateway supplies its own upstream credentials, so the key is not sent. |
+| `forward_llm_key` | `bool` | `wrap()` only. When `True`, auto-extract the provider key from the client (`client.api_key`) and forward it. Default `False` (opt-in) — the caller's key is not sent to the gateway unless requested. |
+| `policy_id` | `str \| None` | Guardrails policy ID to apply (optional) |
+
+**Fail-closed by default:** `require_guardrails` defaults to `True` on `init()`, `wrap()`, and the plugins. If guardrails can't be applied — missing config, an unrecognized client, or a plugin used standalone (e.g. passed straight to `create_agent`/`Agent` without `flintai.init()`) — a `FlintAIGuardrailsError` is raised instead of sending traffic unguarded. Pass `require_guardrails=False` to opt out.
+
+## Environment Variables
+
+Instead of passing credentials in code, you can set them as environment variables:
+
+| Environment Variable | Parameter | Description |
+|---|---|---|
+| `FLINTAI_GATEWAY_URL` | `gateway_url` | Guardrails proxy URL |
+| `FLINTAI_API_KEY` | `api_key` | Your guardrails API key |
+| `FLINTAI_LLM_API_KEY` | `llm_api_key` | Your upstream LLM provider API key |
+| `FLINTAI_POLICY_ID` | `policy_id` | Guardrails policy ID (optional) |
+| `AGENT_ID` | `agent_id` | Agent identifier attached to guardrails requests (overrides `agent_name`) |
+| `FLINTAI_ALLOWED_GATEWAY_HOSTS` | — | Comma-separated allowlist of permitted gateway hostnames. Defaults to `app.flintai.dev`; set to override (or `*` to allow any host). Loopback is always allowed. |
+
+Set the variables in your shell or in a `.env` file (requires `pip install "flintai-sdk-py[dotenv]"`):
+
+```bash
+# .env
+FLINTAI_GATEWAY_URL=https://guardrails.example.com
+FLINTAI_API_KEY=your-guardrails-api-key
+FLINTAI_LLM_API_KEY=your-llm-api-key
+```
+
+Then use the FlintAI SDK without passing credentials:
+
+```python
+import openai
+import flintai
+
+client = openai.OpenAI()
+client = flintai.wrap(client)  # reads from env vars / .env file
+```
+
+**Precedence:** Explicit parameters > environment variables > auto-extract from `client.api_key` (only in `wrap()`, and only when `forward_llm_key=True`).
+
+**Multiple provider keys:** If multiple provider API keys are set in the environment (`OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, `GOOGLE_API_KEY`), auto-detection will fail. Pass `provider` explicitly to `flintai.init()` to disambiguate.
+
+## Gateway Allowlist
+
+By default, `gateway_url` must resolve to `app.flintai.dev` (the hosted FlintAI guardrails gateway); any other host is rejected so provider keys can't be sent to an unintended endpoint. To use a self-hosted or alternate gateway, set `FLINTAI_ALLOWED_GATEWAY_HOSTS` to a comma-separated list of allowed hostnames (or `*` to disable the check). Loopback hosts (`localhost`, `127.0.0.1`, `::1`) are always allowed for local development. Plaintext `http://` is rejected except for loopback.
+
+## How It Works
+
+1. `flintai.wrap(client, gateway_url=..., ...)` auto-detects the provider from the client type, computes the provider-specific path prefix (`/openai`, `/anthropic`, `/gemini`), rewrites the client's base URL, and injects custom headers (`X-FlintAI-API-Key`, `X-Guardrails-Policy-Id`, and `X-LLM-API-Key` only when a provider key is provided or `forward_llm_key=True`)
+2. The guardrails proxy intercepts the request, applies policy checks (detectors), and strips the custom headers
+3. The proxy injects the appropriate upstream auth credentials and forwards the request to the LLM provider
+
+**Global state:** Each `flintai.wrap()` call updates the global FlintAI SDK client's guardrails config. If you wrap multiple clients with different parameters, each client retains its own headers and base URL, but only the last `wrap()` call's config is stored globally. For most applications (single provider, shared credentials), this is transparent.
+
+## Known Limitations
+
+**Private attribute mutation:** `flintai.wrap()` modifies internal attributes of LLM SDK clients (`_base_url`, `_custom_headers`, `_api_client._http_options`) to redirect traffic through the guardrails proxy. These are not part of the public API of the respective SDKs and may change without notice. Pin your SDK versions to the tested ranges:
+
+- `openai>=2.40.0,<3`
+- `anthropic>=0.105.2,<1`
+- `google-genai>=2.7,<3`
+
+**Google GenAI `api_key`:** Google GenAI clients do not expose `api_key` as an attribute. You must pass `llm_api_key=` explicitly when calling `flintai.wrap()`.
+
+**Google GenAI URL normalization:** The Google GenAI SDK requires a trailing slash on the base URL. The FlintAI SDK normalizes this automatically — do not add a trailing slash to `gateway_url`.
+
+**Async clients:** Async clients (`AsyncOpenAI`, `AsyncAnthropic`) are not supported. Use sync clients only.
+
+**Thread safety:** `flintai.init()`, `flintai.wrap()`, and `flintai.shutdown()` are not thread-safe. Call them from the main thread during application startup. Once initialized, wrapped clients can be used from any thread — the underlying SDK clients handle their own thread safety.
+
+## Plugins
+
+Plugins handle events from the FlintAI SDK lifecycle. Subclass `FlintAIPlugin` and override the methods you care about:
+
+```python
+from flintai.plugins import FlintAIPlugin
+
+class MyPlugin(FlintAIPlugin):
+    name = "my-plugin"
+
+    def on_init(self, client):
+        print(f"Plugin initialized with {client}")
+
+    def on_shutdown(self):
+        print("Shutting down")
+
+# Register after init
+flintai.init()
+flintai.register_plugin(MyPlugin())
+```
+
+### Plugin Methods
+
+| Method | Called when |
+|--------|-----------|
+| `on_init(client)` | Plugin is registered |
+| `on_shutdown()` | `flintai.shutdown()` is called |
+
+## Development
+
+```bash
+# Install with dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Lint
+ruff check .
+
+# Type check
+mypy src
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).