castorini-onboard

Castorini Onboard

Unified development environment setup for the Castorini Python repos, whether the user wants one repo or several.

Supported Repos

Repo	PyPI Name	CLI Binary	GitHub
nuggetizer	nuggetizer	nuggetizer	castorini/nuggetizer
ragnarok	pyragnarok	ragnarok	castorini/ragnarok
rank_llm	rank-llm	rank-llm	castorini/rank_llm
umbrela	umbrela	umbrela	castorini/umbrela

Context Detection

1. If cwd is inside one of the 4 repos (check for pyproject.toml with matching project name) → install that one.
2. If the user explicitly asks for one repo, install only that repo.
3. If cwd is the monorepo root or elsewhere and the request is ambiguous → ask which repo(s) to install, or install all if the user says so.

Prerequisites

• Python 3.11+
• Git (SSH access to github.com:castorini)

uv Detection

command -v uv

If present, use uv silently. If absent, ask the user once: install uv or proceed with pip.

Virtual Environment Preference

• Prefer a shared .venv-shared in the current workspace root over repo-local .venv directories.
• Before creating any environment, check whether .venv-shared already exists in the current workspace root and reuse it if present.
• Only fall back to a repo-local environment if the shared environment is unavailable or the user explicitly asks for isolation.

Install Flow

1. Resolve which repository or repositories are in scope.
2. Clone any missing repositories with SSH access to castorini/<repo>.
3. Reuse .venv-shared when it already exists in the workspace root.
4. Prefer uv for sync and dependency-group support.
5. Fall back to pip only when uv is unavailable or the user explicitly asks.
6. For the common multi-repo cloud/API source install, prefer one shared editable install command:

uv pip install \
  -e './ragnarok[cloud,api]' \
  -e './nuggetizer[api]' \
  -e './umbrela[cloud,api]' \
  -e './rank_llm[openai,api]'