quix-ai-sdk 0.2.0__tar.gz

quix_ai_sdk-0.2.0/.gitignore

@@ -0,0 +1,12 @@
+__pycache__/
+*.py[oc]
+.venv/
+dist/
+.pytest_cache/
+.ruff_cache/
+*.egg-info/
+.env*
+.DS_Store
+.idea/
+.vscode/
+.coverage

quix_ai_sdk-0.2.0/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+Format: [Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versions follow SemVer.
+
+## [0.2.0] - 2026-07-22
+
+### Added
+
+- New admin surface: `agents`, `knowledge`, `mcp` modules — typed CRUD plus
+  idempotent `ensure_*` reconcilers with `dry_run=True` ChangeReport previews
+  and per-call `token=`. Org-admin PAT required for writes.
+- `agents.ensure_analysis_agent()`: curated sandbox-workflow analysis agent,
+  prompt shipped in-package.
+- `knowledge.sync_resource()`: sha256-compare upload skip + processing poll.
+- `mcp.ensure_access()`: merge-based grants that never clobber other agents.
+
+## [0.1.0] - unreleased
+
+### Added
+
+- `run(prompt, *, agent_id, context, resume, timeout)` → `RunResult`
+  (`.text`, `.activities`, `.usage`, `.session_id`, `.status`, `.error`).
+- `stream(prompt, ...)` async iterator of distilled typed events
+  (`TextChunk`, `ToolCalled`, `CodeGenerated`, `QueryRan`, `Progress`,
+  `Failed`, `Done`); `raw=True` for wire-level SSE dicts.
+- Per-call `token=` override on `run()` and `stream()` for user-forwarding consumers.
+- Env-only config (`Quix__Portal__Api`, `Quix__Workspace__Id`, `QUIX_TOKEN`).
+- Typed errors: `QuixAIError`, `MissingConfigError`, `AuthError`,
+  `RunTimeout`, `StreamInterrupted` (carries `session_id` for `resume=`).
+- Offline contract test suite with recorded-format SSE fixtures + capture
+  script; opt-in live smoke (`pytest -m live`); API-drift tripwire.

quix_ai_sdk-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 Quix Analytics Ltd.
+
+   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.

quix_ai_sdk-0.2.0/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: quix-ai-sdk
+Version: 0.2.0
+Summary: Prompt in, analysis out — Python SDK for Quix.AI data-analysis runs
+Project-URL: Repository, https://github.com/quixio/quix-ai-sdk
+Project-URL: Changelog, https://github.com/quixio/quix-ai-sdk/blob/main/CHANGELOG.md
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Description-Content-Type: text/markdown
+
+# quix-ai-sdk
+
+Prompt in, analysis out. One method launches a Quix.AI agent session: a
+sandboxed sub-agent writes fresh analysis code for your prompt, queries the
+lakehouse, and streams conclusions back.
+
+```python
+from quix_ai_sdk import run
+
+result = run("Compare sector times between the two fastest laps of the last session")
+print(result)              # the agent's conclusions
+result.activities          # typed log: tools called, code generated, queries run
+result.session_id          # resume handle + audit id
+```
+
+## Install
+
+```bash
+uv add quix-ai-sdk        # or: pip install quix-ai-sdk
+```
+
+## Configuration (env only)
+
+| variable | meaning |
+|---|---|
+| `Quix__Portal__Api` | portal base URL |
+| `Quix__Workspace__Id` | workspace scope for the analysis sandbox |
+| `QUIX_TOKEN` | **a user PAT** — see below |
+
+> **QUIX_TOKEN must be a user PAT.** Quix.AI sessions are user-owned — opening
+> one requires a real user's PAT. The `Quix__Sdk__Token` that deployments
+> auto-inject is a service token and cannot run Quix.AI sessions. Deployments
+> that run analyses (e.g. automated post-race summaries) must therefore add
+> `QUIX_TOKEN` as a secret. Missing vars raise `MissingConfigError` naming the
+> variable.
+
+### Acting as a user
+
+Web apps forwarding a logged-in user's token pass `token=` to `run()` or `stream()`:
+
+```python
+result = run("Summarize", token=request.user.quix_token)
+```
+
+The env `QUIX_TOKEN` is the default; `token=` is the only per-call override.
+When a real user triggers the run, pass their token — fall back to env
+`QUIX_TOKEN` only for headless/automated runs (attribution and permissions
+follow the token). **Never log the token value or call args containing it.**
+
+## Streaming
+
+```python
+import asyncio
+from quix_ai_sdk import stream, TextChunk, Done
+
+async def main():
+    async for event in stream("Find anomalies in brake temperature"):
+        if isinstance(event, TextChunk):
+            print(event.text, end="")
+        elif isinstance(event, Done):
+            print(f"\nsession: {event.session_id}")
+
+asyncio.run(main())
+```
+
+Distilled events: `TextChunk`, `ToolCalled`, `CodeGenerated`, `QueryRan`,
+`Progress`, `Failed`, `Done`. Pass `raw=True` for wire-level SSE dicts.
+
+## Follow-ups
+
+```python
+first = run("Summarize the session")
+more = run("Expand on the tyre wear point", resume=first.session_id)
+```
+
+## Provisioning (0.2): agents / knowledge / mcp
+
+One-time setup of the AI resources your analyses run on. These live in
+submodules (`agents`, `knowledge`, `mcp`), not in the root namespace. Every
+write needs an **org-admin** user PAT (`token=` per call or env `QUIX_TOKEN`).
+
+```python
+from quix_ai_sdk import agents, runs
+
+agent_id = agents.ensure_analysis_agent(token=ORG_ADMIN_PAT)  # once per org
+result = runs.run(f"Analyze test {test_id} ...", agent_id=agent_id)
+```
+
+`ensure_analysis_agent()` creates (or updates) an org agent with a curated,
+versioned system prompt shipped in-package: lakehouse query discipline, the
+delegate_task sandbox workflow, honest handling of missing data. Append
+app-specific rules with `extra_prompt=`. All `ensure_*` functions are
+idempotent and support `dry_run=True` previews. Full guide: [docs/admin.md](docs/admin.md).
+
+## Failure model
+
+- Agent outcome → in the result: `result.status == "failed"`, detail in `result.error`. Never raises.
+- Infrastructure → typed exceptions under `QuixAIError`: `MissingConfigError`, `AuthError`, `RunTimeout`, `StreamInterrupted`.
+- **A dropped stream cancels the run server-side** (platform behavior). The
+  session survives: `StreamInterrupted.session_id` feeds `resume=`. The SDK
+  never auto-retries — a retried run duplicates cost and side effects.
+
+## Logging
+
+The SDK logs to stdlib `logging` under the `quix_ai_sdk` logger and never
+configures handlers. Suggested app-side setup:
+
+```python
+import logging
+
+handler = logging.StreamHandler()
+handler.setFormatter(logging.Formatter("%(asctime)s [%(levelname)-8s] [%(name)s] %(message)s"))
+logging.getLogger("quix_ai_sdk").setLevel(logging.INFO)
+logging.getLogger("quix_ai_sdk").addHandler(handler)
+```
+
+More runnable examples in `examples/`. Module docs in `docs/`.

quix_ai_sdk-0.2.0/README.md

@@ -0,0 +1,117 @@
+# quix-ai-sdk
+
+Prompt in, analysis out. One method launches a Quix.AI agent session: a
+sandboxed sub-agent writes fresh analysis code for your prompt, queries the
+lakehouse, and streams conclusions back.
+
+```python
+from quix_ai_sdk import run
+
+result = run("Compare sector times between the two fastest laps of the last session")
+print(result)              # the agent's conclusions
+result.activities          # typed log: tools called, code generated, queries run
+result.session_id          # resume handle + audit id
+```
+
+## Install
+
+```bash
+uv add quix-ai-sdk        # or: pip install quix-ai-sdk
+```
+
+## Configuration (env only)
+
+| variable | meaning |
+|---|---|
+| `Quix__Portal__Api` | portal base URL |
+| `Quix__Workspace__Id` | workspace scope for the analysis sandbox |
+| `QUIX_TOKEN` | **a user PAT** — see below |
+
+> **QUIX_TOKEN must be a user PAT.** Quix.AI sessions are user-owned — opening
+> one requires a real user's PAT. The `Quix__Sdk__Token` that deployments
+> auto-inject is a service token and cannot run Quix.AI sessions. Deployments
+> that run analyses (e.g. automated post-race summaries) must therefore add
+> `QUIX_TOKEN` as a secret. Missing vars raise `MissingConfigError` naming the
+> variable.
+
+### Acting as a user
+
+Web apps forwarding a logged-in user's token pass `token=` to `run()` or `stream()`:
+
+```python
+result = run("Summarize", token=request.user.quix_token)
+```
+
+The env `QUIX_TOKEN` is the default; `token=` is the only per-call override.
+When a real user triggers the run, pass their token — fall back to env
+`QUIX_TOKEN` only for headless/automated runs (attribution and permissions
+follow the token). **Never log the token value or call args containing it.**
+
+## Streaming
+
+```python
+import asyncio
+from quix_ai_sdk import stream, TextChunk, Done
+
+async def main():
+    async for event in stream("Find anomalies in brake temperature"):
+        if isinstance(event, TextChunk):
+            print(event.text, end="")
+        elif isinstance(event, Done):
+            print(f"\nsession: {event.session_id}")
+
+asyncio.run(main())
+```
+
+Distilled events: `TextChunk`, `ToolCalled`, `CodeGenerated`, `QueryRan`,
+`Progress`, `Failed`, `Done`. Pass `raw=True` for wire-level SSE dicts.
+
+## Follow-ups
+
+```python
+first = run("Summarize the session")
+more = run("Expand on the tyre wear point", resume=first.session_id)
+```
+
+## Provisioning (0.2): agents / knowledge / mcp
+
+One-time setup of the AI resources your analyses run on. These live in
+submodules (`agents`, `knowledge`, `mcp`), not in the root namespace. Every
+write needs an **org-admin** user PAT (`token=` per call or env `QUIX_TOKEN`).
+
+```python
+from quix_ai_sdk import agents, runs
+
+agent_id = agents.ensure_analysis_agent(token=ORG_ADMIN_PAT)  # once per org
+result = runs.run(f"Analyze test {test_id} ...", agent_id=agent_id)
+```
+
+`ensure_analysis_agent()` creates (or updates) an org agent with a curated,
+versioned system prompt shipped in-package: lakehouse query discipline, the
+delegate_task sandbox workflow, honest handling of missing data. Append
+app-specific rules with `extra_prompt=`. All `ensure_*` functions are
+idempotent and support `dry_run=True` previews. Full guide: [docs/admin.md](docs/admin.md).
+
+## Failure model
+
+- Agent outcome → in the result: `result.status == "failed"`, detail in `result.error`. Never raises.
+- Infrastructure → typed exceptions under `QuixAIError`: `MissingConfigError`, `AuthError`, `RunTimeout`, `StreamInterrupted`.
+- **A dropped stream cancels the run server-side** (platform behavior). The
+  session survives: `StreamInterrupted.session_id` feeds `resume=`. The SDK
+  never auto-retries — a retried run duplicates cost and side effects.
+
+## Logging
+
+The SDK logs to stdlib `logging` under the `quix_ai_sdk` logger and never
+configures handlers. Suggested app-side setup:
+
+```python
+import logging
+
+handler = logging.StreamHandler()
+handler.setFormatter(logging.Formatter("%(asctime)s [%(levelname)-8s] [%(name)s] %(message)s"))
+logging.getLogger("quix_ai_sdk").setLevel(logging.INFO)
+logging.getLogger("quix_ai_sdk").addHandler(handler)
+```
+
+More runnable examples in `examples/`. Module docs in `docs/`.

quix_ai_sdk-0.2.0/pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "quix-ai-sdk"
+version = "0.2.0"
+license = "Apache-2.0"
+description = "Prompt in, analysis out — Python SDK for Quix.AI data-analysis runs"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = ["httpx>=0.27"]
+
+[project.urls]
+Repository = "https://github.com/quixio/quix-ai-sdk"
+Changelog = "https://github.com/quixio/quix-ai-sdk/blob/main/CHANGELOG.md"
+
+[dependency-groups]
+dev = [
+    "pytest>=8",
+    "pytest-asyncio>=0.24",
+    "ruff>=0.8",
+    "ty",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/quix_ai_sdk"]
+
+[tool.hatch.build.targets.sdist]
+only-include = ["src", "README.md", "CHANGELOG.md"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "C4", "SIM", "RUF"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+markers = ["live: hits the real dev portal (opt-in: pytest -m live)"]
+addopts = "-m 'not live'"

quix_ai_sdk-0.2.0/src/quix_ai_sdk/__init__.py

@@ -0,0 +1,64 @@
+"""quix-ai-sdk — prompt in, analysis out.
+
+    from quix_ai_sdk import run
+
+    result = run("Compare lap times across the last test session")
+    print(result)
+
+Public API = this file's re-exports. Everything else is private.
+"""
+
+from __future__ import annotations
+
+import logging
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("quix-ai-sdk")
+except PackageNotFoundError:  # running from a checkout without install
+    __version__ = "0.0.0"
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())
+
+from .errors import (  # noqa: E402
+    AuthError,
+    MissingConfigError,
+    QuixAIError,
+    RunTimeout,
+    StreamInterrupted,
+)
+from .events import (  # noqa: E402
+    Activity,
+    CodeGenerated,
+    DistilledEvent,
+    Done,
+    Failed,
+    Progress,
+    QueryRan,
+    TextChunk,
+    ToolCalled,
+    Usage,
+)
+from .runs import RunResult, run, stream  # noqa: E402
+
+__all__ = [
+    "Activity",
+    "AuthError",
+    "CodeGenerated",
+    "DistilledEvent",
+    "Done",
+    "Failed",
+    "MissingConfigError",
+    "Progress",
+    "QueryRan",
+    "QuixAIError",
+    "RunResult",
+    "RunTimeout",
+    "StreamInterrupted",
+    "TextChunk",
+    "ToolCalled",
+    "Usage",
+    "__version__",
+    "run",
+    "stream",
+]