chore: housekeeping — sync 3.3.4 version + recommend uv for installs - #1414
Merged
Merged
Conversation
The v3.3.4 release prep landed on main but was never merged back into develop, leaving every version-bearing file one release behind. Bumps pyproject.toml, mempalace/version.py, both plugin manifests, the marketplace entry, the README badge, and the lockfile to 3.3.4 to match the tagged release.
End-user installs now lead with `uv tool install mempalace`, with `pip install mempalace` kept as a fallback. Dev/contributor docs lead with `uv sync --extra dev` and `uv run` for tests/benchmarks/lint, with the equivalent pip recipe kept inline. The shipped `/mempalace:init` skill instructions (mempalace/instructions/init.md) try `uv tool install` first when uv is on PATH, then fall back through the pip variants. Adds a .python-version pin at 3.12 because the lockfile's onnxruntime==1.24.3 only ships wheels for Python >=3.11; without the pin, `uv sync` on a host where uv prefers 3.10 fails with no source distribution available, which would make the documented command a footgun. pyproject's `requires-python = ">=3.9"` is unchanged — pip users on 3.9/3.10 are unaffected. Files updated: README.md, CONTRIBUTING.md, CLAUDE.md, the gemini-cli guide and example, the .claude-plugin / .codex-plugin READMEs, the mempalace SKILL, the openclaw SKILL, tools/save.md, the three benchmarks docs, and the corresponding website mirrors.
Contributor
There was a problem hiding this comment.
Pull request overview
Housekeeping PR that (1) syncs the repository’s versioned artifacts to 3.3.4 and (2) updates install/contributor documentation to recommend uv (with pip as fallback), including updating various mirrored website/plugin docs.
Changes:
- Bump version from
3.3.3→3.3.4acrosspyproject.toml,mempalace/version.py, plugin manifests, README badge, anduv.lock. - Update docs and skill instructions to prefer
uv tool install/uv sync/uv runfor installs, dev setup, and running commands. - Add a
.python-versionpin (3.12) to match the documenteduvworkflow expectations.
Reviewed changes
Copilot reviewed 23 out of 24 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| website/reference/contributing.md | Switch contributor setup/test commands to uv sync / uv run. |
| website/reference/benchmarks.md | Update benchmark setup install command to uv sync --extra dev. |
| website/guide/getting-started.md | Recommend uv tool install for end-user install; uv sync for from-source. |
| website/guide/gemini-cli.md | Update Gemini CLI setup to use uv sync and uv run (with pip fallback). |
| uv.lock | Update editable mempalace package version to 3.3.4. |
| tools/save.md | Recommend uv tool install for having mempalace installed. |
| README.md | Recommend uv tool install; bump version badge to 3.3.4; update benchmark reproduction commands. |
| pyproject.toml | Bump project version to 3.3.4. |
| mempalace/version.py | Bump __version__ to 3.3.4. |
| mempalace/instructions/init.md | Update init skill instructions to prefer uv tool install and adjust checks/fallbacks. |
| integrations/openclaw/SKILL.md | Recommend uv tool install for OpenClaw setup. |
| examples/gemini_cli_setup.md | Update example setup to use uv sync and uv run (with pip fallback). |
| CONTRIBUTING.md | Switch contributor setup/test/benchmark commands to uv sync / uv run. |
| CLAUDE.md | Update dev commands (tests/lint/format) to use uv run. |
| benchmarks/README.md | Update benchmark setup to uv sync --extra dev. |
| benchmarks/HYBRID_MODE.md | Update benchmark setup to uv sync --extra dev. |
| benchmarks/BENCHMARKS.md | Update benchmark setup to uv sync --extra dev; use uv pip / uv run in one section. |
| .python-version | Add Python version pin 3.12. |
| .codex-plugin/README.md | Update Codex plugin docs to recommend uv in prerequisites and uv sync for git install. |
| .codex-plugin/plugin.json | Bump plugin version to 3.3.4. |
| .claude-plugin/skills/mempalace/SKILL.md | Recommend uv tool install when mempalace isn’t installed. |
| .claude-plugin/README.md | Update post-install wording to reflect uv tool / pip installation. |
| .claude-plugin/plugin.json | Bump plugin version to 3.3.4. |
| .claude-plugin/marketplace.json | Bump marketplace manifest version to 3.3.4. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+18
to
+19
| is available) to detect an existing install. If found, report it and skip | ||
| to Step 4. |
Comment on lines
42
to
46
| 2. Install the Python package (uv recommended): | ||
|
|
||
| ```bash | ||
| pip install -e . | ||
| uv sync # or: pip install -e . | ||
| ``` |
- mempalace/instructions/init.md: only skip Step 4 when `mempalace --version` succeeds. `pip show` / `uv tool list` reporting an install is not enough -- if the package lives in an unactivated venv, Step 5 (`mempalace init ...`) fails with command-not-found. Treat that case as not-installed and re-install via Step 3 into a PATH-visible location. - .codex-plugin/README.md: switch the git-install recipe from `uv sync` to `uv tool install --editable .` so the bundled `plugin.json` (which invokes `mempalace-mcp` by bare name) can launch the MCP server. Plain `uv sync` only puts the script in `.venv/bin/`, which Codex won't find unless the venv is activated first.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two unrelated-but-overdue housekeeping items, bundled because both touch
install-related surfaces and there is no reason to land them apart.
1. Sync the 3.3.4 version bump back into develop
The
chore/release-3.3.4-prepPR (#1232) merged intomainand wastagged as
v3.3.4on 2026-04-30, but never merged back intodevelop.Every version-bearing file on
developstill reads3.3.3:pyproject.tomlmempalace/version.py.claude-plugin/marketplace.json.claude-plugin/plugin.json.codex-plugin/plugin.jsonuv.locktests/test_version_consistency.pykeeps these locked together; it nowpasses against
3.3.4.mempalace --versionreports3.3.4after thebump.
The descriptive
v3.3.3references intests/test_corpus_origin_integration.pyare intentional baseline-pincomments and are left alone.
2. Recommend
uvas the package managerEnd-user installs lead with
uv tool install mempalace, withpip install mempalacekept as a fallback. Dev/contributor docs leadwith
uv sync --extra devanduv runfor tests/benchmarks/lint, withthe equivalent pip recipe kept inline. The shipped
/mempalace:initskill instructions try
uv tool installfirst whenuvis on PATH andfall back through the pip variants.
A
.python-versionpin at3.12is included because the lockfile'sonnxruntime==1.24.3only ships wheels for Python ≥3.11; without thepin,
uv syncon a host whereuvprefers 3.10 fails with no sourcedistribution available, which would make the documented command a
footgun.
requires-python = ">=3.9"is unchanged — pip users on 3.9/3.10 are unaffected.
Files updated:
README.md,CONTRIBUTING.md,CLAUDE.md, thegemini-cli guide and example, the
.claude-plugin/.codex-pluginREADMEs, the mempalace SKILL, the openclaw SKILL,
tools/save.md, thethree benchmarks docs, and the corresponding website mirrors.
Test plan
uv tool install mempalacefrom PyPI installs the CLI on PATH(
mempalace,mempalace-mcp);mempalace --version→3.3.3(PyPI release before this bump). After the bump lands and
republishes, the CLI will report
3.3.4.uv sync --extra devresolves cleanly with the new.python-versionpin (122 packages).uv run pytest tests/ --ignore=tests/benchmarks→1634 passed, 1 skipped.
tests/test_version_consistency.py→ 2 passed.uvx --from 'ruff>=0.4.0,<0.5' ruff check .andruff format --check .→ clean (CI-pinned ruff).manifests.
getting-started.md,gemini-cli.md,contributing.md, andbenchmarks.mdmirrors.