From 0a6b5c9ad5809ec2fafc5cdefb002b0b9e19a20a Mon Sep 17 00:00:00 2001 From: Szymon Janikowski Date: Fri, 8 May 2026 09:57:52 +0200 Subject: [PATCH 1/2] docs(readme): migrate install instructions to PyPI MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit nasde-toolkit is on PyPI as of v0.3.2. The README still pinned a git tag (`uv tool install git+https://...@v0.3.0`), which forced a manual bump in user-facing docs at every release. Quick start now reads `uv tool install nasde-toolkit` — version-agnostic, always lands on the latest stable release. Installation reference adds pipx and pip alternatives, documents the upgrade commands per installer, and mentions the in-CLI update notifier and its NASDE_NO_UPDATE_CHECK opt-out. Also updated the dev-build version example (`0.3.2.dev3` instead of `0.3.1.dev3+gabcdef`) — hatch-vcs no longer emits the local-version suffix after #37. Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 86f9e29..440cbf9 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ The fastest path from zero to a working benchmark built from **your own git hist ### 1. Install the CLI ```bash -uv tool install git+https://github.com/NoesisVision/nasde-toolkit.git@v0.3.0 +uv tool install nasde-toolkit nasde --version ``` @@ -204,27 +204,37 @@ You don't *have* to use these — everything they do is just writing files that ## Installation reference -The [Quick start](#quick-start-three-steps) above pins to the latest stable release. Alternative installation modes: +The [Quick start](#quick-start-three-steps) above uses `uv tool install` — recommended because it isolates `nasde` in its own environment and puts only the `nasde` command on PATH. Alternatives: ```bash -# Install the latest development build from main (may include unreleased changes) +# pipx — analogous isolation, popular in Python community +pipx install nasde-toolkit + +# Inside an existing virtual environment +pip install nasde-toolkit + +# Latest unreleased changes from main (for testing PRs and dev builds) uv tool install git+https://github.com/NoesisVision/nasde-toolkit.git -# Install from a local clone (for developing NASDE itself) +# Local clone (for developing NASDE itself) git clone git@github.com:NoesisVision/nasde-toolkit.git cd nasde-toolkit uv sync ``` -Upgrading to a new stable release: +Upgrading to the newest release: ```bash -uv tool install --reinstall git+https://github.com/NoesisVision/nasde-toolkit.git@v0.3.0 +uv tool upgrade nasde-toolkit # if installed via uv tool +pipx upgrade nasde-toolkit # if installed via pipx +pip install --upgrade nasde-toolkit # if installed via pip ``` +`nasde` checks PyPI for newer releases on startup and prints a one-line notice on stderr when an upgrade is available (severity-tinted: patch / minor / major). Disable with `NASDE_NO_UPDATE_CHECK=1` or `CI=true`. + After installation, only `nasde` appears on PATH. Harbor and Opik are bundled as core dependencies. The reviewer agent spawns your already-installed `claude` or `codex` CLI as a subprocess (not bundled), so it reuses whatever authentication you've set up interactively. -Check the installed version with `nasde --version`. Stable releases follow semver tags (e.g. `v0.3.0`); dev installs show versions like `0.3.1.dev3+gabcdef`. +Check the installed version with `nasde --version`. Stable releases follow semver tags (e.g. `v0.3.2`); dev installs from `main` show versions like `0.3.2.dev3`. Release notes for every tagged version live in [CHANGELOG.md](CHANGELOG.md). See [docs/RELEASING.md](docs/RELEASING.md) if you're cutting a release yourself. From b0a02747994d1bc8dfdde8281f1f27b407e71fbd Mon Sep 17 00:00:00 2001 From: Szymon Janikowski Date: Fri, 8 May 2026 10:03:59 +0200 Subject: [PATCH 2/2] docs(readme): note Quick start installs the latest stable from PyPI MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Small clarification — without context, `uv tool install nasde-toolkit` doesn't make it obvious that the user is getting the most recent stable release (vs. some pinned version, or a dev build). One sentence with a PyPI link removes that ambiguity. Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 440cbf9..4b9cf99 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,8 @@ uv tool install nasde-toolkit nasde --version ``` +This installs the latest stable release from [PyPI](https://pypi.org/project/nasde-toolkit/). + ### 2. Install the authoring skills for Claude Code ```bash