wren-langchain 0.2.0__tar.gz

wren_langchain-0.2.0/.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+.coverage
+dist/
+build/
+.venv/
+
+# Local scratch scripts users create at the package root for ad-hoc testing
+# (e.g. agent.py, agent_with_memory_check.py from the local-testing-guide).
+# Anything in tests/ and src/wren_langchain/ stays tracked.
+/agent*.py

wren_langchain-0.2.0/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## [0.2.0](https://github.com/Canner/WrenAI/compare/wren-langchain-v0.1.0...wren-langchain-v0.2.0) (2026-05-14)
+
+
+### Features
+
+* **sdk:** add wren-langchain package for langchain/langgraph integration ([#2247](https://github.com/Canner/WrenAI/issues/2247)) ([f2c3b2d](https://github.com/Canner/WrenAI/commit/f2c3b2d834235e085d28e8726b81fd089028f5fd))

wren_langchain-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 2024 Canner, Inc.
+
+   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.

wren_langchain-0.2.0/PKG-INFO

@@ -0,0 +1,312 @@
+Metadata-Version: 2.4
+Name: wren-langchain
+Version: 0.2.0
+Summary: LangChain and LangGraph integration for Wren AI Core — attach a CLI-prepared Wren project to your agent in three lines.
+Project-URL: Homepage, https://getwren.ai
+Project-URL: Documentation, https://github.com/Canner/WrenAI/tree/main/sdk/wren-langchain#readme
+Project-URL: Repository, https://github.com/Canner/WrenAI
+Project-URL: Issues, https://github.com/Canner/WrenAI/issues
+Project-URL: Changelog, https://github.com/Canner/WrenAI/blob/main/sdk/wren-langchain/CHANGELOG.md
+Author-email: Wren AI <contact@getwren.ai>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: agent,ai-agent,analytics,context-layer,data-modeling,langchain,langgraph,mdl,semantic,sql,wren,wrenai
+Classifier: Development Status :: 4 - Beta
+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: Topic :: Database
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: langchain-core>=0.3
+Requires-Dist: langchain>=1.0
+Requires-Dist: langgraph>=1.0
+Requires-Dist: pydantic>=2
+Requires-Dist: wren-engine>=0.5.0
+Provides-Extra: all
+Requires-Dist: wren-engine[all]>=0.5.0; extra == 'all'
+Provides-Extra: athena
+Requires-Dist: wren-engine[athena]>=0.5.0; extra == 'athena'
+Provides-Extra: bigquery
+Requires-Dist: wren-engine[bigquery]>=0.5.0; extra == 'bigquery'
+Provides-Extra: clickhouse
+Requires-Dist: wren-engine[clickhouse]>=0.5.0; extra == 'clickhouse'
+Provides-Extra: databricks
+Requires-Dist: wren-engine[databricks]>=0.5.0; extra == 'databricks'
+Provides-Extra: dev
+Requires-Dist: pytest-mock>=3; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Requires-Dist: wren-engine[memory]>=0.5.0; extra == 'dev'
+Provides-Extra: memory
+Requires-Dist: wren-engine[memory]>=0.5.0; extra == 'memory'
+Provides-Extra: mssql
+Requires-Dist: wren-engine[mssql]>=0.5.0; extra == 'mssql'
+Provides-Extra: mysql
+Requires-Dist: wren-engine[mysql]>=0.5.0; extra == 'mysql'
+Provides-Extra: oracle
+Requires-Dist: wren-engine[oracle]>=0.5.0; extra == 'oracle'
+Provides-Extra: postgres
+Requires-Dist: wren-engine[postgres]>=0.5.0; extra == 'postgres'
+Provides-Extra: redshift
+Requires-Dist: wren-engine[redshift]>=0.5.0; extra == 'redshift'
+Provides-Extra: snowflake
+Requires-Dist: wren-engine[snowflake]>=0.5.0; extra == 'snowflake'
+Provides-Extra: spark
+Requires-Dist: wren-engine[spark]>=0.5.0; extra == 'spark'
+Provides-Extra: trino
+Requires-Dist: wren-engine[trino]>=0.5.0; extra == 'trino'
+Description-Content-Type: text/markdown
+
+# wren-langchain
+
+LangChain and LangGraph integration for [Wren AI Core](https://github.com/Canner/WrenAI).
+
+Attach a CLI-prepared Wren project to a LangChain agent in three lines:
+
+```python
+from wren_langchain import WrenToolkit
+from langchain.agents import create_agent
+
+toolkit = WrenToolkit.from_project("./analytics_db")
+agent = create_agent(
+    model="openai:gpt-4o",
+    tools=toolkit.get_tools(),
+    system_prompt=toolkit.system_prompt(),
+)
+```
+
+Complete runnable demos:
+
+- [`examples/langchain_demo.py`](./examples/langchain_demo.py) — uses
+  ``langchain.agents.create_agent``, the high-level factory. Smallest
+  amount of code; recommended starting point.
+- [`examples/langgraph_demo.py`](./examples/langgraph_demo.py) — builds the
+  ReAct loop from LangGraph primitives (`StateGraph` + `ToolNode` +
+  conditional edges). Use this when you need custom routing, state, or
+  streaming.
+
+## Prerequisites
+
+This package assumes you have already used the Wren CLI to prepare a project:
+
+```bash
+wren context init
+wren context build
+wren memory index   # optional but recommended
+wren profile add ...
+```
+
+If you haven't installed the CLI yet, install `wren-engine` first:
+
+```bash
+pip install "wren-engine[memory,postgres]"
+```
+
+## Installation
+
+`wren-langchain` exposes datasource and memory extras that pass through to
+the matching `wren-engine` extras, so you only have to install once:
+
+```bash
+# Match the datasource your wren_project.yml uses (DuckDB needs no extra):
+pip install "wren-langchain[mysql]"
+pip install "wren-langchain[postgres,memory]"
+pip install "wren-langchain[bigquery,memory]"
+
+# Available datasource extras: postgres, mysql, bigquery, snowflake,
+# clickhouse, trino, mssql, databricks, redshift, spark, athena, oracle.
+
+# `memory` extra enables the three memory tools (wren_fetch_context,
+# wren_recall_queries, wren_store_query). Without it the toolkit exposes
+# only the three runtime tools.
+
+# Install everything for experimentation:
+pip install "wren-langchain[all,memory]"
+```
+
+If you prefer to install `wren-engine` separately (e.g. you already use the
+CLI), the bare package is enough and your existing `wren-engine` extras carry
+over:
+
+```bash
+pip install wren-langchain
+```
+
+## What you get
+
+`WrenToolkit.from_project(path)` exposes:
+
+- **6 LLM-facing tools** (3 runtime + 3 memory when `.wren/memory/` exists):
+  - `wren_query` — execute SQL through Wren's context layer, returns rows
+  - `wren_dry_plan` — plan SQL without execution to verify it targets models correctly
+  - `wren_list_models` — list project models with column counts and descriptions
+  - `wren_fetch_context` — retrieve relevant schema/business context for a question
+  - `wren_recall_queries` — surface similar past NL→SQL pairs as few-shot examples
+  - `wren_store_query` — persist a confirmed NL→SQL pair for future recall
+- **Direct Python API**:
+  ```python
+  toolkit.query("SELECT ...")             # → pyarrow.Table
+  toolkit.dry_plan("SELECT ...")           # → str (target-dialect SQL)
+  toolkit.dry_run("SELECT ...")            # → None (validation only)
+  toolkit.memory.fetch("revenue trends")
+  toolkit.memory.recall("top customers")
+  toolkit.memory.store(nl="...", sql="...", tags=["..."])
+  ```
+- **`toolkit.system_prompt()`** — Wren-aware system prompt that adapts to enabled tools and includes your project's `instructions.md` when present.
+
+## Configuration
+
+```python
+WrenToolkit.from_project(
+    path,                # required — path to your prepared Wren project
+    profile="prod",      # optional — picks a named profile (default: active)
+)
+
+toolkit.get_tools(
+    include_memory_write=True,   # set False to keep memory read-only
+    raise_on_error=False,        # set True to surface exceptions to LangChain retry
+)
+```
+
+Memory is **auto-detected** from the project: present `<path>/.wren/memory/`
+exposes the 3 memory tools alongside the 3 runtime tools; absent → only the
+runtime tools. To enable, run `wren memory index` from the project root; to
+disable, delete the directory. There is no override kwarg.
+
+`include_memory_write=False` removes `wren_store_query` from the returned
+list while keeping `wren_fetch_context` and `wren_recall_queries`. Use this
+when you want the agent to read curated past pairs but never persist new
+ones (e.g., a shared / pinned memory). When memory is disabled, this flag
+has no effect — no memory tools are returned regardless.
+
+### How `path`, `profile`, and `.env` interact
+
+Three pieces of state combine to produce a connection. Understanding which
+one drives what avoids surprises:
+
+| Source | Holds | Resolved by |
+|---|---|---|
+| `path/wren_project.yml` + `target/mdl.json` | MDL models, schema, `data_source` | `from_project(path)` |
+| `path/.env` | Secret values (`MYSQL_HOST`, `MYSQL_PASSWORD`, …) | `from_project(path)` auto-loads it |
+| `~/.wren/profiles.yml` | Connection template (`host: ${MYSQL_HOST}`, …) | `profile=` kwarg or fallback chain |
+
+**`profile=` resolution chain** (highest priority first):
+
+1. Explicit `profile="<name>"` kwarg passed to `from_project`.
+2. The `profile:` field inside the project's `wren_project.yml`, e.g.:
+   ```yaml
+   schema_version: 3
+   data_source: mysql
+   profile: test-project3   # locks this project to a specific profile
+   ```
+3. The globally active profile (`wren profile switch <name>`).
+
+### When does `profile=` actually change which database you connect to?
+
+This is subtle, because **profile values are templates that resolve from the
+project's `.env`**, not standalone connection records. Three scenarios:
+
+**Scenario A — `profile=` is a no-op (most common)**
+
+Your `~/.wren/profiles.yml` has multiple profiles that all use the same
+placeholder names:
+
+```yaml
+profiles:
+  test-project3:
+    datasource: mysql
+    host: ${MYSQL_HOST}
+    database: ${MYSQL_DATABASE}
+  test-project4:
+    datasource: mysql
+    host: ${MYSQL_HOST}        # ← same placeholder
+    database: ${MYSQL_DATABASE}
+```
+
+Because `from_project("/path/to/test-project3")` loads `test-project3/.env`
+into the environment, **both profiles resolve to the same connection** —
+`${MYSQL_HOST}` reads from project3's `.env` regardless of which profile
+name you picked. Profile selection is cosmetic in this layout.
+
+**Scenario B — `profile=` selects different placeholders**
+
+```yaml
+profiles:
+  dev:
+    host: ${DEV_HOST}
+  prod:
+    host: ${PROD_HOST}
+```
+
+Now `profile="dev"` and `profile="prod"` read different env vars from the
+same `.env`, so the choice matters.
+
+**Scenario C — `profile=` selects hardcoded values or different datasources**
+
+```yaml
+profiles:
+  local:
+    datasource: duckdb
+    url: /tmp/local.duckdb
+    format: duckdb
+  remote:
+    datasource: postgres
+    host: prod-db.example.com   # hardcoded
+    port: 5432
+```
+
+`profile="local"` vs `profile="remote"` connect to genuinely different
+databases. Note: if `wren_project.yml` specifies `data_source:` and you
+pick a profile with a different `datasource:`, the connection will fail —
+the project's MDL is built against one specific dialect.
+
+### Recommendation: one project, one profile
+
+If you follow the common pattern of **one Wren project per database**
+(each project gets its own `.env` and points at its own DB), set the
+profile inside `wren_project.yml` and stop passing `profile=`:
+
+```yaml
+# wren_project.yml
+schema_version: 3
+name: test-project3
+data_source: mysql
+profile: test-project3
+```
+
+```python
+toolkit = WrenToolkit.from_project("/path/to/test-project3")
+```
+
+This pins the project to its intended profile, no more "is the active
+profile what I think it is?" — and it survives `wren profile switch`
+elsewhere on the same machine.
+
+## Compatibility matrix
+
+| `wren-langchain` | `wren-engine` | `langchain` | `langgraph` |
+|---|---|---|---|
+| 0.1.0 | >= 0.5.0 | >= 1.0 | >= 1.0 |
+
+## Known limitations (v0.1)
+
+- **Synchronous tools only.** LangChain auto-bridges to a thread pool when tools run in async LangGraph; multi-tenant servers serving > ~32 concurrent users may exhaust the default executor pool.
+- **One toolkit per agent.** If you need to query multiple Wren projects, build separate agents.
+- **Memory is auto-detected** from `.wren/memory/` and there is no kwarg to override. To enable, run `wren memory index`; to disable, delete the directory.
+- **No hot reload mechanism.** `target/mdl.json` is re-read on every tool call, so `wren context build` updates from CLI are picked up automatically. Profile changes require constructing a new toolkit.
+- **Don't run `wren memory index` while an agent is using the same project.** The index operation drops and recreates the LanceDB schema table; concurrent reads may transiently fail.
+
+## License
+
+Apache License 2.0. See [LICENSE](./LICENSE) for the full text, or the
+[repository-level LICENSE](../../LICENSE) for the path-to-license map.
+
+The names "Wren", "WrenAI", and the project's logos are trademarks of
+Canner, Inc. and are not licensed under Apache 2.0; their use is governed
+separately.