Skip to content

CLI for SidePulse

Python

Add isolated user installer

Colby483e4c4eae6d
diff --git a/README.md b/README.md
index 94ad686..0752401 100644
--- a/README.md
+++ b/README.md
@@ -203,6 +203,17 @@ Install locally for the `sidepulse` CLI:
python3 -m pip install -e .
```
+For an isolated user installation that does not modify system Python packages:
+
+```sh
+./scripts/install-user.sh
+~/.local/bin/sidepulse setup
+```
+
+The installer creates `~/.local/share/sidepulse/venv` and links the CLI into
+`~/.local/bin`. Override `PYTHON_BIN`, `SIDEPULSE_INSTALL_ROOT`, or
+`SIDEPULSE_BIN_DIR` when a different location is needed.
+
This also installs the Cocoa dependencies for the macOS status-bar app.
Set up this Mac explicitly after package install:
diff --git a/scripts/install-user.sh b/scripts/install-user.sh
new file mode 100755
index 0000000..ccb5ece
--- /dev/null
+++ b/scripts/install-user.sh
@@ -0,0 +1,20 @@
+#!/bin/sh
+set -eu
+
+PYTHON_BIN=${PYTHON_BIN:-python3}
+INSTALL_ROOT=${SIDEPULSE_INSTALL_ROOT:-"$HOME/.local/share/sidepulse"}
+BIN_DIR=${SIDEPULSE_BIN_DIR:-"$HOME/.local/bin"}
+SOURCE_DIR=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
+VENV_DIR="$INSTALL_ROOT/venv"
+
+"$PYTHON_BIN" -m venv "$VENV_DIR"
+"$VENV_DIR/bin/python" -m pip install --upgrade pip
+"$VENV_DIR/bin/python" -m pip install "$SOURCE_DIR"
+
+mkdir -p "$BIN_DIR"
+ln -sf "$VENV_DIR/bin/sidepulse" "$BIN_DIR/sidepulse"
+ln -sf "$VENV_DIR/bin/agent-monitor" "$BIN_DIR/agent-monitor"
+
+printf '%s\n' "SidePulse installed in $VENV_DIR"
+printf '%s\n' "CLI linked at $BIN_DIR/sidepulse"
+printf '%s\n' "Run: $BIN_DIR/sidepulse setup"
diff --git a/tests/test_install_user.py b/tests/test_install_user.py
new file mode 100644
index 0000000..83855be
--- /dev/null
+++ b/tests/test_install_user.py
@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+import os
+import subprocess
+import tempfile
+import unittest
+from pathlib import Path
+
+
+class UserInstallerTests(unittest.TestCase):
+ def test_installer_uses_isolated_venv_and_user_bin(self) -> None:
+ root = Path(__file__).resolve().parents[1]
+ script = root / "scripts" / "install-user.sh"
+ text = script.read_text()
+ self.assertIn('"$PYTHON_BIN" -m venv "$VENV_DIR"', text)
+ self.assertIn('"$VENV_DIR/bin/python" -m pip install', text)
+ self.assertNotIn("--break-system-packages", text)
+
+ def test_installer_shell_syntax(self) -> None:
+ root = Path(__file__).resolve().parents[1]
+ result = subprocess.run(
+ ["sh", "-n", str(root / "scripts" / "install-user.sh")],
+ check=False,
+ capture_output=True,
+ text=True,
+ )
+ self.assertEqual(result.returncode, 0, result.stderr)
+
+
+if __name__ == "__main__":
+ unittest.main()