Add docs

tools/README.md

@@ -6,8 +6,18 @@ This folder contains various command-line tools that are used to facilitate diff
 
 This command is used to updates the Meson build files in the project. It automatically adds new source files (py, pyx) to the Meson files and removes deleted source files. This command is useful when adding or removing source files from the project.
 
-Within an active virtual environment where Meson is installed, run the following command:
+Within an active virtual environment where `meson` is installed, run the following command:
 
 ```bash
 tools/update_meson.py
 ```
+
+## Update Lock Files
+
+This command automatically updates the lock files for the project dependencies (the ones in the `./requirements/` directory). This command is useful when adding or removing dependencies from the project, or when updating the dependencies.
+
+Within an active virtual environment where `pip-tools` and `toml` are installed, run the following command:
+
+```bash
+tools/update-lock.py
+```

tools/update-lock.py

@@ -1,4 +1,6 @@
+#!/usr/bin/env python3
 # pyright: strict
+
 import argparse
 import subprocess
 from pathlib import Path
@@ -45,11 +47,11 @@ def compile_requirements(pyproject_file: Path, groups: dict[str, list[str]]) ->
     description="Update lock files under requirements using pip-tools compile."
 )
 parser.add_argument(
-    "sourcedir", help="The source directory of the pyproject.toml file."
+    "sourcedir", help="Source directory", nargs="?", default=".", type=Path
 )
-args = parser.parse_args()
+options = parser.parse_args()
 
-pyproject_file = Path(args.sourcedir) / "pyproject.toml"
+pyproject_file = Path(options.sourcedir) / "pyproject.toml"
 with pyproject_file.open("r") as f:
     pyproject = toml.load(f)