spectron-google-adk 0.1.0__tar.gz

spectron_google_adk-0.1.0/.env.example

@@ -0,0 +1,8 @@
+# Spectron connection. The SDK never reads these itself; the examples in this
+# repo load them and pass the values to the client explicitly.
+SPECTRON_ENDPOINT=https://api.spectron.example
+SPECTRON_API_KEY=sk-spec-your-key-here
+SPECTRON_CONTEXT=acme-prod
+
+# Google ADK model provider. Required for the example agents to talk to Gemini.
+GOOGLE_API_KEY=your-google-api-key-here

spectron_google_adk-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: test (py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+
+      - name: Set up Python
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Lint
+        run: ruff check .
+
+      - name: Test
+        run: pytest -q
+
+  build:
+    name: build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+
+      - name: Set up Python
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        with:
+          python-version: "3.12"
+          cache: pip
+
+      - name: Build and check
+        run: |
+          python -m pip install --upgrade pip build twine
+          python -m build
+          twine check dist/*

spectron_google_adk-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,61 @@
+name: Release
+
+# Publish to PyPI via Trusted Publishing (OIDC — no API tokens).
+# Fires only on v-prefixed tags, e.g. `v0.1.0`.
+on:
+  push:
+    tags: ["v*"]
+
+permissions: {}
+
+jobs:
+  build:
+    name: build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+
+      - name: Set up Python
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        with:
+          python-version: "3.12"
+          cache: pip
+
+      - name: Check tag matches package version
+        run: |
+          tag="${GITHUB_REF_NAME#v}"
+          version="$(python -c 'import tomllib; print(tomllib.load(open("pyproject.toml","rb"))["project"]["version"])')"
+          if [ "$tag" != "$version" ]; then
+            echo "::error::Tag '$GITHUB_REF_NAME' (=$tag) does not match pyproject version '$version'"
+            exit 1
+          fi
+          echo "Releasing version $version"
+
+      - name: Build and check
+        run: |
+          python -m pip install --upgrade pip build twine
+          python -m build
+          twine check dist/*
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write # required for PyPI Trusted Publishing
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0

spectron_google_adk-0.1.0/.gitignore

@@ -0,0 +1,20 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Environment files
+.env
+
+# Tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/

spectron_google_adk-0.1.0/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 2026 SurrealDB 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.

spectron_google_adk-0.1.0/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: spectron-google-adk
+Version: 0.1.0
+Summary: SurrealDB Spectron memory as tools for Google Agent Development Kit (ADK) agents.
+Project-URL: Homepage, https://surrealdb.com/platform/spectron
+Project-URL: Documentation, https://surrealdb.com/docs/learn/spectron
+Project-URL: Repository, https://github.com/surrealdb-dev/spectron-google-adk
+Author: SurrealDB
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: adk,agent,google-adk,llm,memory,spectron,surrealdb
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+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 :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Requires-Dist: google-adk>=1.0.0
+Requires-Dist: surrealdb>=3.0.0a1
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# spectron-google-adk
+
+Give [Google ADK](https://github.com/google/adk-python) agents persistent
+memory backed by [Spectron](https://surrealdb.com/platform/spectron),
+SurrealDB's agent-memory layer.
+
+This package wraps Spectron's memory verbs as ADK tools. An agent can store
+facts, search them back, forget them, and reason over them, with memory that
+survives restarts and separate conversations. Spectron handles entity
+extraction, knowledge-graph storage, temporal facts, and hybrid retrieval; this
+package is the thin layer that hands those verbs to an ADK agent.
+
+## Install
+
+```bash
+pip install spectron-google-adk
+```
+
+This pulls in `google-adk` and `surrealdb`. The Spectron client ships in the
+`surrealdb` package (3.0.0a1 and later), which is installed for you from PyPI.
+
+## Configuration
+
+Spectron needs a context id, an endpoint, and an API key. The Spectron SDK does
+not read environment variables itself, so you pass these in explicitly. For
+scripts, `SpectronConfig.from_env()` reads them from the environment for you:
+
+```bash
+export SPECTRON_CONTEXT="acme-prod"
+export SPECTRON_ENDPOINT="https://api.spectron.example"
+export SPECTRON_API_KEY="sk-spec-..."
+export GOOGLE_API_KEY="your-google-api-key"   # used by the ADK model
+```
+
+See `.env.example` for the full list.
+
+## Quickstart
+
+```python
+import asyncio
+from google.adk.agents import Agent
+from google.adk.runners import InMemoryRunner
+from spectron_google_adk import SpectronToolset
+
+async def main():
+    toolset = SpectronToolset(
+        context="acme-prod",
+        endpoint="https://api.spectron.example",
+        api_key="sk-spec-...",
+    )
+
+    agent = Agent(
+        model="gemini-2.5-flash",
+        name="assistant",
+        description="An assistant with persistent memory.",
+        instruction="Store durable facts with remember and look things up with recall.",
+        tools=[toolset],
+    )
+
+    runner = InMemoryRunner(agent=agent)
+    try:
+        await runner.run_debug("Remember: Acme Corp, healthcare, 1.2M dollar contract.")
+        events = await runner.run_debug("What healthcare contracts do we have?")
+        for event in events:
+            if event.is_final_response() and event.content:
+                for part in event.content.parts:
+                    if part.text:
+                        print(part.text)
+    finally:
+        await runner.close()
+        await toolset.close()
+
+asyncio.run(main())
+```
+
+`SpectronToolset` extends ADK's `BaseToolset`, so an ADK `Runner` closes it on
+shutdown. When the toolset creates the client, `close()` closes that client too.
+
+## Two ways to build tools
+
+### SpectronToolset (recommended)
+
+Owns the client and manages its lifecycle. Add it to an agent as a single item
+in the `tools` list:
+
+```python
+toolset = SpectronToolset(config=SpectronConfig.from_env())
+agent = Agent(model="gemini-2.5-flash", name="assistant", tools=[toolset])
+```
+
+### get_spectron_tools (for quick scripts)
+
+Returns a plain list of tools. Pass your own `client` when you want to control
+its lifecycle; otherwise the client it creates lives for the process:
+
+```python
+from surrealdb.spectron import AsyncSpectron
+from spectron_google_adk import get_spectron_tools
+
+client = AsyncSpectron(context="acme-prod", endpoint="...", api_key="sk-...")
+tools = get_spectron_tools(client=client)
+agent = Agent(model="gemini-2.5-flash", name="assistant", tools=tools)
+```
+
+## Session and tenant isolation
+
+Bind a `session_id` (and optionally a `scope`) when you build the tools. The
+values are fixed at build time and are not exposed to the model, so an agent
+cannot read or write outside its slice of memory:
+
+```python
+toolset = SpectronToolset(config=config, session_id="user-123")
+```
+
+Two agents built with the same `session_id` share memory; agents on different
+session ids stay isolated. See `examples/sessionized_memory.py`.
+
+## Choosing which verbs to expose
+
+By default all of the verbs below are available. Pass `include=[...]` to expose
+a subset, for example a collector agent that can only write and a researcher
+agent that can only read (see `examples/multi_agent.py`):
+
+```python
+collector = SpectronToolset(config=config, include=["remember"])
+researcher = SpectronToolset(config=config, include=["recall", "reflect"])
+```
+
+## Tools
+
+| Tool | Argument | What the agent uses it for |
+| --- | --- | --- |
+| `remember` | `text` | Store a fact, preference, or piece of information. |
+| `recall` | `query` | Search memory and get back ranked matching passages. |
+| `forget` | `query` | Remove information that matches a description. |
+| `reflect` | `query` | Get a written summary synthesized from memory, with evidence. |
+| `chat` | `message` | Ask memory a question and get a grounded natural-language answer. |
+| `consolidate` | (none) | Pool recent facts into durable observations. |
+| `elaborate` | `entity_ref` | Expand an entity's relationships from stored facts. |
+| `query_context` | `query` | Build a composed context string for grounding a response. |
+| `inspect` | `ref` | Inspect a single memory object by reference. |
+| `state` | (none) | Get a snapshot of current working memory. |
+
+Every tool returns a JSON-safe dict with a `status` key that is `"success"` or
+`"error"`. A failed Spectron request becomes
+`{"status": "error", "message": ..., "status_code": ..., "trace_id": ...}` so
+the model sees it as data rather than the agent turn failing.
+
+## Examples
+
+- `examples/quickstart.py` - one agent that stores a fact and recalls it.
+- `examples/sessionized_memory.py` - memory isolation across sessions.
+- `examples/multi_agent.py` - a writer agent and a reader agent sharing a context.
+
+Fill in `.env` from `.env.example`, then run any example, for example
+`python examples/quickstart.py`.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+The tests use a fake client, so they need no network access or credentials.
+
+## Links
+
+- Spectron: https://surrealdb.com/platform/spectron
+- Spectron docs: https://surrealdb.com/docs/learn/spectron
+- Google ADK: https://github.com/google/adk-python
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE).