Merge pull request #3172 from IntersectMBO/clusterlib_reinstall_editable

feat(dev): add make target for editable clusterlib install

Author: mkoura

Makefile

@@ -35,6 +35,17 @@ build_doc:
 doc:
 	./scripts/deploy_doc.sh
 
+
+# reinstall cardano-clusterlib-py in editable mode from a given git repository
+.PHONY: reinstall-editable
+reinstall-editable:
+	@if [ -z "$(repo)" ]; then \
+		echo "Usage: make reinstall-editable repo=/path/to/cardano-clusterlib-py" >&2; \
+		exit 1; \
+	fi
+	@./scripts/clusterlib_reinstall_editable.sh "$(repo)"
+
+
 # run tests
 
 TESTS_DIR ?= cardano_node_tests/

README.md

@@ -200,6 +200,12 @@ prepare-cluster-scripts -c -d dev_workdir/conway_fast -t conway_fast
 make check_dev_env
 ```
 
+### 🧰 Reinstall `cardano-clusterlib` in Editable Mode
+
+```sh
+make reinstall-editable repo=../cardano-clusterlib-py
+```
+
 ### 🧪 Run Individual Tests
 
 ```sh
@@ -214,18 +220,6 @@ source "$(poetry env info --path)"/bin/activate
 make lint
 ```
 
-### 🧰 Use `cardano-clusterlib` in Dev Mode
-
-```sh
-source "$(poetry env info --path)"/bin/activate
-make install
-pip uninstall cardano-clusterlib
-cd ../cardano-clusterlib-py
-pip install -e . --config-settings editable_mode=compat
-cd -
-python -c 'from cardano_clusterlib import clusterlib_klass; print(clusterlib_klass.__file__)'
-```
-
 > ⚠️ After each dependencies update, repeat the steps above to retain dev mode.
 
 ### 📦 Update Poetry Dependencies

scripts/clusterlib_reinstall_editable.sh

@@ -0,0 +1,72 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+err() { printf "Error: %s\n" "$*" >&2; }
+usage() { printf "Usage: %s /path/to/cardano-clusterlib-py\n" "${0}"; }
+
+if [ $# -ne 1 ]; then
+  usage
+  exit 64
+fi
+REPO_PATH=$1
+
+TOP_DIR="$(readlink -m "${0%/*}/..")"
+cd "$TOP_DIR" >/dev/null
+
+# Sanity checks
+if [ -n "${IN_NIX_SHELL:-""}" ]; then
+  err "This script is not supposed to run inside nix shell."
+  exit 1
+fi
+
+# Activate poetry virtual environment
+if [ -z "${VIRTUAL_ENV:-}" ]; then
+  # shellcheck disable=SC2091
+  $(poetry env activate)
+  # Override PYTHONPATH to prefer virtual environment packages over nix packages
+  PYTHONPATH="$(echo "$VIRTUAL_ENV"/lib/python3*/site-packages):${PYTHONPATH:-}"
+  export PYTHONPATH
+fi
+if [ -z "${VIRTUAL_ENV:-}" ]; then
+  err "Failed to activate virtual environment."
+  exit 1
+fi
+
+# Double-check python is actually running inside a venv
+if ! python - <<'PY'
+import sys
+raise SystemExit(0 if sys.prefix != getattr(sys, "base_prefix", sys.prefix) else 1)
+PY
+then
+  err "Python indicates it's not running inside a virtual environment."
+  exit 1
+fi
+
+# Check that cardano-clusterlib is installed
+if ! python -m pip show cardano-clusterlib >/dev/null 2>&1; then
+  err "Package 'cardano-clusterlib' is not installed in this environment."
+  exit 1
+fi
+
+# Validate repo path
+if [ ! -d "$REPO_PATH" ]; then
+  err "Repo path not found: $REPO_PATH"
+  exit 1
+fi
+if [[ ! -f "$REPO_PATH/pyproject.toml" && ! -f "$REPO_PATH/cardano_clusterlib" ]]; then
+  err "Given path doesn't look like the cardano-clusterlib-py repo."
+  exit 1
+fi
+
+echo "Uninstalling 'cardano-clusterlib' from current environment..."
+python -m pip uninstall -y cardano-clusterlib
+
+echo "Installing editable from: $REPO_PATH"
+cd "$REPO_PATH" >/dev/null
+python -m pip install -e . --config-settings editable_mode=compat
+
+echo
+echo "Verifying editable install (should point into your repo, not site-packages):"
+cd "$TOP_DIR" >/dev/null
+python -c 'from cardano_clusterlib import clusterlib_klass; print(clusterlib_klass.__file__)'