signal-bot/scripts/ensure_venv.sh
Krzysztof kuhy Rudnicki 99aa194ad8 fix: the tagger sets up its own venv instead of failing on a missing one
"python tool/tagger.py --untagged" died with ModuleNotFoundError: fastapi.
The dependencies live in .venv and nothing said so. run.sh had the same hole
and answered it by printing the two commands to type and exiting 1 -- which
is the same rule broken one step further along: a script owns its
dependencies, and making the user be the installer is not owning them.

scripts/ensure_venv.sh creates .venv and installs the project editable if the
interpreter cannot already import fastapi and signal_bot. Idempotent and
cheap: the normal case is two file tests and one import check, 0.17s, so
entry points call it unconditionally. tag.sh is the tagger's entry point and
run.sh now uses the same helper.

Verified on a clone with no .venv at all: ./tag.sh --help created the
environment, installed the project and printed the usage.

Editable on purpose -- a later git pull updates what the tagger runs, which
is the same reason install.sh does it that way in the sibling repos.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WBrE1b9HvFw3xvG9bJiDFt
2026-08-31 13:28:49 +02:00

50 lines
1.7 KiB
Bash
Executable File

#!/bin/bash
# ============================================================================
# Make sure .venv exists and has this project installed in it.
#
# run.sh used to answer a missing venv with a message telling you to type
# "uv venv .venv && uv pip install -e '.[dev]'" yourself, and tool/tagger.py
# did not even do that -- it failed with ModuleNotFoundError: fastapi. Both
# are the same rule broken: a script owns its dependencies.
#
# Sourced or executed. Idempotent: the common case is two file tests and no
# subprocess at all, so entry points can call it unconditionally.
# ============================================================================
set -euo pipefail
ensure_venv() {
local repo_root="$1"
local venv="${repo_root}/.venv"
local python="${venv}/bin/python"
# Already good: the interpreter exists and the project imports from it.
if [[ -x "$python" ]] && "$python" -c 'import fastapi, signal_bot' 2>/dev/null; then
return 0
fi
echo "== setting up ${venv} (one-off)" >&2
if [[ ! -x "$python" ]]; then
if command -v uv >/dev/null; then
uv venv "$venv"
elif ! python3 -m venv "$venv"; then
echo "Error: could not create a virtualenv at ${venv}" >&2
echo " python3 -m venv failed; on Arch: sudo pacman -S python" >&2
return 1
fi
fi
# Editable, so a later git pull updates what the tagger actually runs.
if command -v uv >/dev/null; then
VIRTUAL_ENV="$venv" uv pip install -e "${repo_root}[dev]"
else
"$python" -m pip install -e "${repo_root}[dev]"
fi
}
# Executed rather than sourced: do the thing, for callers that are not bash.
if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
ensure_venv "$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
fi