arrayview 0.12.0__tar.gz → 0.12.2__tar.gz

{arrayview-0.12.0 → arrayview-0.12.2}/.claude/skills/viewer-ui-checklist/SKILL.md

@@ -1,13 +1,13 @@
 ---
 name: viewer-ui-checklist
-description: Use when adding keyboard shortcuts, changing layout, or making any UI change to arrayview. Ensures visual_smoke.py stays in sync.
+description: Use when adding keyboard shortcuts, changing layout, or making any UI change to arrayview. Ensures visual_smoke.py, help overlay, and README stay in sync.
 ---
 
 # ArrayView UI Checklist
 
 ## Rule
 
-Every UI change to arrayview MUST be reflected in `tests/visual_smoke.py` before the task is complete.
+Every UI change to arrayview MUST be reflected in `tests/visual_smoke.py`, the help overlay, and (when user-facing) `README.md` before the task is complete.
 
 ## What counts as a UI change
 
@@ -35,6 +35,14 @@ Every UI change to arrayview MUST be reflected in `tests/visual_smoke.py` before
 
 4. **Open and review** the new screenshots in `tests/smoke_output/`
 
+5. **Update `GUIDE_TABS`** in `_viewer.html` if you added, removed, or changed a keybinding
+   - Add/update the entry in the appropriate tab and section
+   - Include a `hint` for non-obvious shortcuts
+   - Use the `docs-style` skill for formatting rules
+
+6. **Update `README.md`** if the change is user-facing (new CLI flag, new API, new mode)
+   - Use the `docs-style` skill for formatting rules
+
 ## Red flags — STOP
 
 - "The shortcut is too simple to need a smoke test" → ALL shortcuts need entries

{arrayview-0.12.0 → arrayview-0.12.2}/AGENTS.md

@@ -15,7 +15,8 @@ Load the relevant skill before touching the corresponding area.
 | `frontend-designer` | Styling/layout changes to `_viewer.html` |
 | `vscode-simplebrowser` | Extension, signal-file IPC, `_VSCODE_EXT_VERSION` |
 | `invocation-consistency` | Server startup, display-opening, env detection |
-| `docs-style` | README, help overlay, docstrings |
+| `viewer-ui-checklist` | Any UI change (smoke tests, help overlay, README sync) |
+| `docs-style` | README, help overlay, docstrings (formatting rules) |
 
 ## Non-Negotiables
 
@@ -29,6 +30,12 @@ Load the relevant skill before touching the corresponding area.
 - All colorbar state (animation, window/level, hover, drag) flows through `primaryCb` ColorBar instance — never read/write legacy globals. Multiview colorbars sync via `primaryCb`.
 - Keybinds flow through the command registry (`commands` / `keybinds` in `_viewer.html`), not inline keydown branches. The help overlay auto-generates from command `title` fields — do not hand-edit it.
 
+## Contributing
+
+Before creating a PR or making user-facing changes, read `CONTRIBUTING.md`. It defines the design
+language, keybinding conventions, overlay/popup patterns, and testing requirements. All PRs that
+touch the viewer must follow it.
+
 ## Execution
 
 Always use **subagent-driven development** for implementation. Commit completed work automatically.

arrayview-0.12.2/CONTRIBUTING.md

@@ -0,0 +1,93 @@
+# Contributing to arrayview
+
+Thanks for your interest. This guide keeps things consistent as more people
+contribute.
+
+## Proposing changes
+
+For anything user-facing (new shortcut, overlay, layout change), **open an
+issue first**. Include:
+
+- What it does, in one sentence
+- Which key triggers it (if any)
+- Which modes it affects (Normal, Multi-view, Compare, Diff, Registration, qMRI)
+- A rough sketch or description of how it looks
+
+Bug fixes and internal refactors can go straight to a PR.
+
+## Design principles
+
+1. **Array fills the screen.** Minimize chrome. UI elements stay hidden or
+   dimmed until the user hovers or presses a key, then fade back out.
+
+2. **Monospace only.** All text uses the system monospace stack
+   (`'SF Mono', ui-monospace, 'Cascadia Code', 'JetBrains Mono', monospace`).
+   Never use sans-serif.
+
+3. **Colors via CSS custom properties.** Use `var(--surface)`, `var(--text)`,
+   `var(--active-dim)`, etc. Never hardcode hex values. The viewer ships four
+   themes (dark, light, solarized, nord) and all must work.
+
+4. **Yellow for active state.** `--active-dim` (#f5c842 in dark theme) marks
+   the currently active element. Don't introduce new accent colors.
+
+5. **All six modes.** Every visual feature must be tested across Normal,
+   Multi-view (V/v), Compare (B/P), Diff (X), Registration (R), and qMRI (q).
+   If your feature only applies to some modes, add explicit mode guards.
+
+## Keyboard shortcuts
+
+- Check the existing shortcut table (press `?` in the viewer) before picking a
+  key. Conflicts will be caught in review but save yourself the round-trip.
+- Single lowercase letters are scarce. Prefer Shift+key or a modifier for new
+  features.
+- If a shortcut only makes sense in certain modes, guard it:
+  ```js
+  if (currentMode !== 'compare') return;
+  ```
+- Document the new shortcut in the help overlay (`#help-overlay` in
+  `_viewer.html`).
+
+## Popup menus and overlays
+
+Several proposals involve popup/context menus. To keep them visually
+consistent:
+
+- Background: `var(--surface)`, border: `1px solid var(--border)`,
+  border-radius: `var(--radius-lg)`.
+- Dismiss on **Escape** and on clicking outside the popup.
+- No permanent visibility -- show on trigger, hide when done.
+- Keep text small (12-13px) and monospace.
+- Use `var(--active-dim)` for the selected/hovered item, `var(--text)` for
+  normal items, `var(--muted)` for secondary info.
+- Animate in with a short opacity+scale transition, not an instant pop.
+
+Look at `#uni-picker-box` in `_viewer.html` for a reference implementation.
+
+## Testing checklist
+
+Before submitting a PR:
+
+- [ ] `uv run pytest tests/test_api.py -x` passes
+- [ ] `uv run python tests/visual_smoke.py` passes
+- [ ] If you added UI, update `tests/visual_smoke.py` to cover it
+- [ ] Manually verify in all affected modes (at minimum: Normal + one
+      multi-pane mode)
+- [ ] New shortcuts are documented in the help overlay
+
+## Dev setup
+
+```bash
+git clone <repo-url>
+cd arrayview
+uv sync
+uv run arrayview tests/  # launch with test data
+```
+
+## Style notes
+
+- The frontend lives in a single file: `src/arrayview/_viewer.html`.
+  HTML, CSS, and JS are all in there. Keep it that way.
+- Python backend uses `uv` for package management.
+- Commit messages follow conventional commits (`feat:`, `fix:`, `refactor:`,
+  etc.).

{arrayview-0.12.0 → arrayview-0.12.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arrayview
-Version: 0.12.0
+Version: 0.12.2
 Summary: Fast multi-dimensional array viewer
 Project-URL: Home, https://github.com/oscarvanderheide/arrayview
 Project-URL: Source, https://github.com/oscarvanderheide/arrayview

{arrayview-0.12.0 → arrayview-0.12.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "arrayview"
-version = "0.12.0"
+version = "0.12.2"
 description = "Fast multi-dimensional array viewer"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.12"

arrayview-0.12.2/scripts/release.sh

@@ -0,0 +1,138 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# ---------------------------------------------------------------------------
+# release.sh — bump version, commit, tag, push, create GitHub release
+# ---------------------------------------------------------------------------
+
+BUMP="minor"
+DRY_RUN=true
+NO_AI=false
+
+usage() {
+    cat <<EOF
+Usage: $(basename "$0") [OPTIONS]
+
+Options:
+  --bump {major,minor,patch}   Version bump type (default: minor)
+  --execute                    Actually run (default is dry-run)
+  --no-ai                      Skip AI release notes, use GitHub's --generate-notes
+  -h, --help                   Show this help
+EOF
+}
+
+while [[ $# -gt 0 ]]; do
+    case "$1" in
+        --bump)   BUMP="$2"; shift 2 ;;
+        --execute) DRY_RUN=false; shift ;;
+        --no-ai)  NO_AI=true; shift ;;
+        -h|--help) usage; exit 0 ;;
+        *) echo "Unknown option: $1"; usage; exit 1 ;;
+    esac
+done
+
+if [[ ! "$BUMP" =~ ^(major|minor|patch)$ ]]; then
+    echo "Error: --bump must be major, minor, or patch (got '$BUMP')"
+    exit 1
+fi
+
+# --- Guard: clean working tree on main ---
+branch=$(git rev-parse --abbrev-ref HEAD)
+if [[ "$branch" != "main" ]]; then
+    echo "Error: must be on main (currently on '$branch')"
+    exit 1
+fi
+
+if ! git diff --quiet || ! git diff --cached --quiet; then
+    echo "Error: working tree is dirty — commit or stash first"
+    exit 1
+fi
+
+# --- Bump version ---
+uv version --bump "$BUMP"
+VERSION=$(uv version --short)
+TAG="v${VERSION}"
+
+echo "Version bumped to $VERSION (tag: $TAG)"
+
+uv lock --quiet
+
+run() {
+    echo "+ $*"
+    if [[ "$DRY_RUN" == true ]]; then
+        return
+    fi
+    "$@"
+}
+
+# --- Generate release notes ---
+CLAUDE_BIN="${CLAUDE_BIN:-/Users/oscar/.local/bin/claude}"
+PREV_TAG=$(git describe --tags --abbrev=0 HEAD 2>/dev/null || echo "")
+NOTES=""
+
+if [[ -n "$PREV_TAG" ]]; then
+    COMMITS=$(git log "${PREV_TAG}..HEAD" --oneline)
+else
+    COMMITS=$(git log --oneline -20)
+fi
+
+if [[ "$NO_AI" == false ]] && command -v "$CLAUDE_BIN" &>/dev/null; then
+    echo "Generating release notes with Claude..."
+    NOTES=$("$CLAUDE_BIN" -p "You are writing release notes for arrayview $TAG (a Python array/image viewer).
+
+Here are the commits since the last release ($PREV_TAG):
+
+$COMMITS
+
+Write concise, user-friendly release notes in this exact format:
+
+## What's new in $TAG
+
+- **Feature name**: one-sentence description
+
+Rules:
+- 5-10 bullet points max — group related commits into one bullet
+- Write for end-users, not developers (no commit hashes, no file names)
+- Use past tense (\"added\", \"fixed\", \"improved\")
+- Skip pure refactors/docs unless they affect user experience
+- Bold the feature name, keep the description to one sentence" 2>/dev/null) || true
+fi
+
+if [[ -z "$NOTES" ]]; then
+    if [[ "$NO_AI" == false ]]; then
+        echo "AI notes unavailable, falling back to --generate-notes"
+    fi
+fi
+
+if [[ "$DRY_RUN" == true && -n "$NOTES" ]]; then
+    echo ""
+    echo "--- Release notes preview ---"
+    echo "$NOTES"
+    echo "-----------------------------"
+    echo ""
+fi
+
+# --- Commit, tag, push, release ---
+run git add pyproject.toml uv.lock
+run git commit -m "release: $TAG"
+run git push origin main
+run git tag "$TAG"
+run git push origin "$TAG"
+
+if [[ -n "$NOTES" ]]; then
+    run gh release create "$TAG" \
+        --title "$TAG" \
+        --notes "$NOTES" \
+        --prerelease
+else
+    run gh release create "$TAG" \
+        --title "$TAG" \
+        --generate-notes \
+        --prerelease
+fi
+
+if [[ "$DRY_RUN" == true ]]; then
+    echo ""
+    echo "(dry-run — re-run with --execute to apply)"
+    git checkout pyproject.toml uv.lock
+fi

{arrayview-0.12.0 → arrayview-0.12.2}/src/arrayview/_stdio_server.py

@@ -637,7 +637,7 @@ def _handle_get_viewer_html(msg: dict) -> None:
     """Return the rendered viewer HTML with template substitutions."""
     from importlib.resources import files as _pkg_files
 
-    from arrayview._config import get_viewer_colormaps
+    from arrayview._config import get_viewer_colormaps, get_viewer_theme
     from arrayview._render import COLORMAP_GRADIENT_STOPS, COMPLEX_MODES, REAL_MODES
     from arrayview._session import COLORMAPS
 
@@ -650,12 +650,17 @@ def _handle_get_viewer_html(msg: dict) -> None:
 
     query_val = json.dumps(f"?sid={sid}&transport=postMessage") if sid else "null"
 
+    _theme_names = ["dark", "light", "solarized", "nord"]
+    _cfg_theme = get_viewer_theme()
+    _default_theme_idx = _theme_names.index(_cfg_theme) if _cfg_theme in _theme_names else 0
+
     html = (
         template.replace("__COLORMAPS__", str(_active_colormaps))
         .replace("__COLORMAP_GRADIENT_STOPS__", json.dumps(COLORMAP_GRADIENT_STOPS))
         .replace("__COMPLEX_MODES__", str(COMPLEX_MODES))
         .replace("__REAL_MODES__", str(REAL_MODES))
         .replace("__ARRAYVIEW_QUERY__", query_val)
+        .replace("__DEFAULT_THEME_IDX__", str(_default_theme_idx))
     )
 
     _write_json({"html": html})