Files
..
…
…

Scripts Directory

Python and shell automation used by the Machine Learning Systems textbook tooling. This directory includes production entrypoints for generated assets, maintenance, release work, Quarto-adjacent helpers, and tooling that has not been migrated into a stable module or Binder command yet.

See binder/tools/README.md for the production-tool policy. Do not delete, rename, or move scripts here without auditing actual QMD, Binder, CI, release, and generation call sites.

Use Binder first

From the repository root:

./binder/binder check all
./binder/binder fix repo-health
./binder/binder help

If your shell is already in book/, use ./binder/binder instead of ./binder/binder.

Command reference and pre-commit mapping: binder/docs/BINDER.md. Implementation details: binder/cli/README.md.

Direct python3 binder/tools/scripts/... use is for maintenance, generation, or cases not wired into Binder yet. Prefer ./binder/binder when a subcommand exists. When a script becomes a core book dependency, prefer to move the stable logic into an importable Book Tools module and keep the script as the CLI entrypoint.

Subfolder docs

Area README
Content tools content/README.md
Images images/README.md
Infra / CI helpers infrastructure/README.md
Utilities utilities/README.md
Extra script notes docs/README.md

Other directories (publish/, maintenance/, testing/, socratiQ/) are documented here only where needed; see source and --help on individual scripts.

Shell entrypoints (often run outside Binder)

These are common when you need the exact script interface:

./binder/tools/scripts/publish/mit-press-release.sh --vol1
./binder/tools/scripts/publish/publish.sh
./binder/tools/scripts/maintenance/run_maintenance.sh

Python scripts

Use Python 3. Most modules support --help:

python3 binder/tools/scripts/publish/extract_figures.py --help