crewai-goodmem 0.1.1__tar.gz

crewai_goodmem-0.1.1/.gitignore

@@ -0,0 +1,39 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+*.egg-info/
+*.egg
+build/
+dist/
+wheels/
+*.whl
+
+# Virtual envs
+.venv/
+.venv-*/
+venv/
+env/
+
+# Tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+.tox/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+.DS_Store
+
+# Local secrets
+.env
+.env.local
+.env.*.local

crewai_goodmem-0.1.1/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.1] — 2026-04-28
+
+### Changed
+- Drop Python 3.10 support. The transitive `onnxruntime` dependency (via
+  `crewai → chromadb`) no longer ships 3.10 wheels in current versions, so
+  installs failed in practice. Supported versions are now 3.11 / 3.12 / 3.13.
+
+### Fixed
+- README install banner correctly states the supported Python range.
+- Pin `UV_PYTHON` per CI matrix entry so `uv run` doesn't silently rebuild
+  the venv against `.python-version` instead of the matrix Python.
+
+## [0.1.0] — 2026-04-27
+
+### Added
+- Initial release.
+- Eleven CrewAI tools covering the GoodMem v1 REST surface: embedders, spaces
+  (CRUD), memories (CRUD), and semantic retrieval with optional reranking, LLM
+  summarization, and SQL-style JSONPath metadata filtering.
+- `wait_for_memories_completed(memory_ids, *, timeout, interval, ...)` helper
+  that polls each memory's `processingStatus` until it reaches a terminal
+  state, replacing blind `time.sleep` waits in the example and live test.
+- Apache 2.0 license, type stubs (PEP 561), and full type annotations.
+- Mocked unit-test suite covering every tool.
+
+[Unreleased]: https://github.com/PAIR-Systems-Inc/goodmem-crewai/compare/v0.1.1...HEAD
+[0.1.1]: https://github.com/PAIR-Systems-Inc/goodmem-crewai/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/PAIR-Systems-Inc/goodmem-crewai/releases/tag/v0.1.0

crewai_goodmem-0.1.1/LICENSE

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

crewai_goodmem-0.1.1/NOTICE

@@ -0,0 +1,5 @@
+crewai-goodmem
+Copyright 2026 PAIR Systems Inc
+
+This product includes software developed at PAIR Systems Inc
+(https://pairsys.ai/).

crewai_goodmem-0.1.1/PKG-INFO

@@ -0,0 +1,302 @@
+Metadata-Version: 2.4
+Name: crewai-goodmem
+Version: 0.1.1
+Summary: GoodMem RAG tools for CrewAI agents
+Project-URL: Homepage, https://github.com/PAIR-Systems-Inc/goodmem-crewai
+Project-URL: Source, https://github.com/PAIR-Systems-Inc/goodmem-crewai
+Project-URL: Documentation, https://docs.goodmem.com/integrations/crewai
+Project-URL: Issues, https://github.com/PAIR-Systems-Inc/goodmem-crewai/issues
+Project-URL: Changelog, https://github.com/PAIR-Systems-Inc/goodmem-crewai/blob/main/CHANGELOG.md
+Author: PAIR Systems Inc
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: agents,crewai,goodmem,memory,rag,tools
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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.14,>=3.11
+Requires-Dist: crewai>=1.14.3
+Requires-Dist: requests<3,>=2.33.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest-cov>=5; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: python-dotenv>=1; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: types-requests; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# crewai-goodmem
+
+GoodMem RAG tools for [CrewAI](https://crewai.com) agents.
+
+[GoodMem](https://goodmem.ai) is a self-hostable RAG service that handles
+embedding, chunking, storage, and retrieval on the server. This package
+exposes its REST surface as eleven `crewai.tools.BaseTool` classes so any
+CrewAI agent can store documents, run semantic search, and manage memory
+spaces directly.
+
+## Install
+
+```bash
+pip install crewai-goodmem
+# or
+uv add crewai-goodmem
+```
+
+Python 3.11–3.13 supported. The only runtime dependencies are `crewai` and
+`requests`.
+
+## Quickstart
+
+```python
+from crewai import Agent, Crew, Task
+from crewai_goodmem import GoodMemRetrieveMemoriesTool
+
+retrieve = GoodMemRetrieveMemoriesTool()  # reads GOODMEM_BASE_URL / GOODMEM_API_KEY
+
+researcher = Agent(
+    role="Knowledge Researcher",
+    goal="Answer questions from the team knowledge base.",
+    backstory="You always cite the retrieved memory chunks.",
+    tools=[retrieve],
+)
+
+task = Task(
+    description="Search space '<your-space-id>' for 'agent skills' and answer.",
+    expected_output="A grounded answer.",
+    agent=researcher,
+)
+
+print(Crew(agents=[researcher], tasks=[task]).kickoff())
+```
+
+A full multi-scenario script lives at [`examples/basic_example.py`](examples/basic_example.py).
+
+## Configuration
+
+Every tool reads the same three environment variables, with constructor
+arguments taking precedence:
+
+| Variable | Required | Description |
+|---|---|---|
+| `GOODMEM_BASE_URL` | Yes | Base URL of your GoodMem server (e.g. `https://localhost:8080`, `https://api.goodmem.ai`). |
+| `GOODMEM_API_KEY`  | Yes | API key issued by your GoodMem instance (starts with `gm_`). |
+| `GOODMEM_VERIFY_SSL` | No | Set to `false` to skip TLS verification when pointing at a server with a self-signed certificate. |
+
+Pass them at construction time instead if you prefer:
+
+```python
+tool = GoodMemRetrieveMemoriesTool(
+    base_url="https://localhost:8080",
+    api_key="gm_...",
+    verify_ssl=False,
+)
+```
+
+## Available tools
+
+Eleven tools cover the complete GoodMem v1 REST surface — embedders, spaces
+(CRUD), memories (CRUD), and semantic retrieval.
+
+| Tool | Operation |
+|---|---|
+| `GoodMemListEmbeddersTool` | `GET /v1/embedders` |
+| `GoodMemListSpacesTool` | `GET /v1/spaces` |
+| `GoodMemGetSpaceTool` | `GET /v1/spaces/{id}` |
+| `GoodMemCreateSpaceTool` | `POST /v1/spaces` (reuses if name exists) |
+| `GoodMemUpdateSpaceTool` | `PUT /v1/spaces/{id}` |
+| `GoodMemDeleteSpaceTool` | `DELETE /v1/spaces/{id}` |
+| `GoodMemCreateMemoryTool` | `POST /v1/memories` |
+| `GoodMemListMemoriesTool` | `GET /v1/spaces/{space_id}/memories` |
+| `GoodMemRetrieveMemoriesTool` | `POST /v1/memories:retrieve` (NDJSON stream) |
+| `GoodMemGetMemoryTool` | `GET /v1/memories/{id}` + `/content` |
+| `GoodMemDeleteMemoryTool` | `DELETE /v1/memories/{id}` |
+
+### GoodMemCreateSpaceTool
+
+Create a new space, or reuse an existing one with the same name.
+
+| Argument | Required | Default | Description |
+|---|---|---|---|
+| `name` | Yes | — | Unique name for the space |
+| `embedder_id` | Yes | — | ID of the embedder model for vector embeddings |
+| `chunk_size` | No | 256 | Characters per chunk when splitting documents |
+| `chunk_overlap` | No | 25 | Overlapping characters between consecutive chunks |
+| `keep_strategy` | No | `KEEP_END` | Separator placement: `KEEP_END`, `KEEP_START`, `DISCARD` |
+| `length_measurement` | No | `CHARACTER_COUNT` | `CHARACTER_COUNT` or `TOKEN_COUNT` |
+
+### GoodMemUpdateSpaceTool
+
+Update a space's name, labels, or `publicRead` flag. Only fields you pass
+are changed.
+
+| Argument | Required | Description |
+|---|---|---|
+| `space_id` | Yes | UUID of the space to update |
+| `name` | No | New name for the space |
+| `public_read` | No | Toggle unauthenticated read access |
+| `replace_labels_json` | No | JSON string that replaces all existing labels |
+| `merge_labels_json` | No | JSON string that merges into existing labels |
+
+`replace_labels_json` and `merge_labels_json` are mutually exclusive.
+
+### GoodMemCreateMemoryTool
+
+Store a document or plain text as a memory. Binary content is base64-encoded
+on upload.
+
+| Argument | Required | Description |
+|---|---|---|
+| `space_id` | Yes | Space to store the memory in |
+| `text_content` | No | Plain text content (used when no file is provided) |
+| `file_path` | No | Local file path (PDF, DOCX, image, etc.). Takes priority over `text_content` |
+| `metadata` | No | Key-value metadata as a JSON object |
+
+### GoodMemListMemoriesTool
+
+List memories in a space with optional filtering and sorting.
+
+| Argument | Required | Default | Description |
+|---|---|---|---|
+| `space_id` | Yes | — | UUID of the space to list from |
+| `status_filter` | No | — | One of `PENDING`, `PROCESSING`, `COMPLETED`, `FAILED` |
+| `include_content` | No | `false` | Include each memory's original content |
+| `sort_by` | No | — | `created_at` or `updated_at` |
+| `sort_order` | No | — | `ASCENDING` or `DESCENDING` |
+
+### GoodMemRetrieveMemoriesTool
+
+Perform semantic search across one or more spaces. Supports reranking, LLM
+summarization, chronological resort, and server-side metadata filtering via
+SQL-style JSONPath expressions.
+
+| Argument | Required | Default | Description |
+|---|---|---|---|
+| `query` | Yes | — | Natural language search query |
+| `space_ids` | Yes | — | List of space IDs to search across |
+| `max_results` | No | 5 | Maximum number of results |
+| `include_memory_definition` | No | `true` | Fetch full memory metadata alongside chunks |
+| `wait_for_indexing` | No | `true` | Retry polling when no results found |
+| `max_wait_seconds` | No | 10 | Maximum seconds to poll when `wait_for_indexing` is `true` |
+| `poll_interval` | No | 2 | Seconds between polling attempts |
+| `reranker_id` | No | — | Reranker model ID for improved ordering |
+| `llm_id` | No | — | LLM ID for contextual response generation |
+| `relevance_threshold` | No | — | Minimum score (0–1). Used with reranker/LLM |
+| `llm_temperature` | No | — | LLM creativity (0–2). Used when `llm_id` is set |
+| `chronological_resort` | No | `false` | Reorder by creation time instead of relevance |
+| `metadata_filter` | No | — | SQL-style JSONPath expression applied server-side. Applied to every space in `space_ids` |
+
+### GoodMemGetMemoryTool
+
+Retrieve a memory by ID with metadata and optionally the original content.
+Text content is returned verbatim (`contentEncoding: "text"`); binary
+content is base64-encoded (`contentEncoding: "base64"`).
+
+| Argument | Required | Default | Description |
+|---|---|---|---|
+| `memory_id` | Yes | — | UUID of the memory to fetch |
+| `include_content` | No | `true` | Also fetch the original document content |
+
+### GoodMemDeleteMemoryTool
+
+Permanently delete a memory and its chunks and embeddings.
+
+| Argument | Required | Description |
+|---|---|---|
+| `memory_id` | Yes | UUID of the memory to delete |
+
+### GoodMemListSpacesTool / GoodMemListEmbeddersTool / GoodMemGetSpaceTool / GoodMemDeleteSpaceTool
+
+`List` tools take no arguments. `GetSpace` and `DeleteSpace` take a single
+`space_id`.
+
+## Waiting for indexing
+
+Memory ingestion is asynchronous: `GoodMemCreateMemoryTool` returns once the
+record exists, but the chunks aren't searchable until the server finishes
+embedding them. Instead of guessing with a fixed sleep, poll the actual
+`processingStatus`:
+
+```python
+from crewai_goodmem import wait_for_memories_completed
+
+statuses = wait_for_memories_completed(
+    [memory_id_1, memory_id_2],
+    timeout=60.0,
+)
+# {'mem-1': 'COMPLETED', 'mem-2': 'COMPLETED'}
+```
+
+The function returns once every id has reached a terminal status
+(`COMPLETED` or `FAILED`), or raises `TimeoutError` if the deadline elapses.
+Configure with `timeout` (max seconds) and `interval` (poll frequency).
+
+## Metadata filtering
+
+Tag memories at creation time and filter server-side at retrieval time:
+
+```python
+from crewai_goodmem import GoodMemCreateMemoryTool, GoodMemRetrieveMemoriesTool
+import json
+
+create = GoodMemCreateMemoryTool()
+retrieve = GoodMemRetrieveMemoriesTool()
+
+create._run(
+    space_id=space_id,
+    text_content="Shipped the CSV export feature.",
+    metadata={"category": "feat"},
+)
+
+result = retrieve._run(
+    query="new features",
+    space_ids=[space_id],
+    metadata_filter="CAST(val('$.category') AS TEXT) = 'feat'",
+)
+print(json.loads(result)["results"])
+```
+
+The filter is a SQL-style JSONPath expression evaluated by GoodMem. When
+set, the same filter is applied to every space in `space_ids`.
+
+## Development
+
+```bash
+uv venv
+uv sync --extra dev
+
+uv run ruff check .
+uv run ruff format --check .
+uv run mypy src
+uv run pytest               # mocked unit tests only
+
+# live tests require a running GoodMem server
+GOODMEM_BASE_URL=https://localhost:8080 \
+GOODMEM_API_KEY=gm_... \
+uv run pytest -m e2e
+```
+
+Conventional Commits are enforced via pre-commit. Install with:
+
+```bash
+uv run pre-commit install
+```
+
+## Links
+
+- [GoodMem documentation](https://docs.goodmem.com/)
+- [GoodMem CrewAI integration docs](https://docs.goodmem.com/integrations/crewai)
+- [CrewAI documentation](https://docs.crewai.com/)
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE) and [NOTICE](NOTICE).