Skip to content

Commit f3a00eb

Browse files
goldmedalclaude
andauthored
docs(wren): rebrand README to Wren AI and expand rename migration note (#2316)
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 20cffa9 commit f3a00eb

1 file changed

Lines changed: 23 additions & 11 deletions

File tree

core/wren/README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
[![Python](https://img.shields.io/pypi/pyversions/wrenai.svg)](https://pypi.org/project/wrenai/)
55
[![License](https://img.shields.io/pypi/l/wrenai.svg)](https://github.com/Canner/WrenAI/blob/main/LICENSE)
66

7-
Wren Engine CLI and Python SDK — semantic SQL layer for 20+ data sources.
7+
Wren AI CLI and Python SDK — semantic SQL layer for 20+ data sources.
88

9-
Translate natural SQL queries through an [MDL (Modeling Definition Language)](https://docs.getwren.ai/) semantic layer and execute them against your database. Powered by [Apache DataFusion](https://datafusion.apache.org/) and [Ibis](https://ibis-project.org/).
9+
Translate natural SQL queries through an [MDL (Modeling Definition Language)](https://docs.getwren.ai/) semantic layer and execute them against your database. Powered by [Apache DataFusion](https://datafusion.apache.org/).
1010

1111
## Installation
1212

@@ -225,22 +225,34 @@ uv run pytest tests/test_profile_web.py -v
225225

226226
## Package rename: `wren-engine` → `wrenai`
227227

228-
Starting with the 0.7.0 release, this package is published on PyPI as
229-
[`wrenai`](https://pypi.org/project/wrenai/). The legacy
230-
[`wren-engine`](https://pypi.org/project/wren-engine/) project on PyPI is
231-
frozen at 0.6.x and no longer receives updates.
228+
Starting with the 0.7.0 release, this PyPI distribution is renamed from
229+
[`wren-engine`](https://pypi.org/project/wren-engine/) to
230+
[`wrenai`](https://pypi.org/project/wrenai/) to align with the **Wren AI**
231+
brand. The legacy `wren-engine` project on PyPI is frozen at 0.6.x and
232+
will not receive further updates.
232233

233-
Nothing about the Python API or the CLI changes — `import wren`, the
234-
`wren` command, and every subcommand stay the same. Only the
235-
distribution name on PyPI is different.
234+
### What stays the same
236235

237-
To migrate:
236+
- The Python import path: `import wren` (and submodules under `wren.*`)
237+
- The `wren` CLI entrypoint and every subcommand (`wren query`,
238+
`wren context`, `wren profile`, `wren memory`, …)
239+
- All extras (`postgres`, `mysql`, `bigquery`, …, `memory`, `ui`, `main`,
240+
`all`)
241+
- Configuration files under `~/.wren/` (profiles, memory, config)
242+
243+
Only the name you type after `pip install` is different.
244+
245+
### Migration
238246

239247
```bash
240248
pip uninstall wren-engine
241-
pip install wrenai # or: pip install "wrenai[<extras>]"
249+
pip install wrenai # or: pip install "wrenai[<extras>]"
250+
wren --version # should print: wrenai X.Y.Z
242251
```
243252

253+
If your project pinned `wren-engine` in a `requirements.txt`,
254+
`pyproject.toml`, or lockfile, replace it with `wrenai` and re-lock.
255+
244256
## License
245257

246258
Apache-2.0

0 commit comments

Comments
 (0)