Table of Contents generated with DocToc

dev/ directory guidelines

Scripts

New scripts in dev/ must be standalone Python scripts (not bash). Each script must include inline script metadata placed after the Apache License header, so that uv run can execute it without any prior installation:

#!/usr/bin/env python3
# Licensed to the Apache Software Foundation (ASF) ...
#   http://www.apache.org/licenses/LICENSE-2.0
# ...
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "some-package",
# ]
# ///

If the script only uses the standard library, omit the dependencies key but keep the requires-python line.

Run scripts with:

uv run dev/my_script.py [args...]

Document uv run (not python) as the invocation method in READMEs and instructions.