tools: harden path handling and align docs/options

ADDING_NEW_UD_VERSION.md

@@ -244,7 +244,7 @@ du -sh ../parquet/
 uv run ./05_validate_parquet.py --local --test
 
 # Full validation (optional, takes ~30-60 minutes)
-uv run ./05_validate_parquet.py --local --mode text -vv > /tmp/parquet-check.log
+uv run ./05_validate_parquet.py --local -vv > /tmp/parquet-check.log
 
 # Check for errors (excluding metadata comments)
 grep -E "         [+-]" /tmp/parquet-check.log | grep -vE "         [+-]#"
@@ -424,7 +424,7 @@ If you need to preserve artifacts for debugging:
 **Symptoms:**
 ```
 ITEM DELETED - no summary: UD_Language-Treebank
-ITEM DELETED - no files  : UD_Language-Treebank
+ITEM DELETED - no files: UD_Language-Treebank
 ITEM DELETED - no license: UD_Language-Treebank
 ```
 
@@ -490,7 +490,7 @@ Before marking the release as complete:
 
 - [ ] `.env` file updated with new version
 - [ ] Metadata files generated (`citation-{VER}`, `description-{VER}`, `codes_and_flags-{VER}.yaml`)
-- [ ] All UD repositories fetched and checked out to correct tag
+- [ ] UD snapshot downloaded and `UD_repos` symlink points to `ud-treebanks-v{VER}`
 - [ ] `metadata-{VER}.json` generated with blocked treebank info
 - [ ] `README-{VER}` generated
 - [ ] Parquet files generated for all non-blocked treebanks

tools/00_fetch_ud_clarin-dspace_metadata.py

@@ -28,11 +28,11 @@ description_url_prefix = "https://lindat.mff.cuni.cz/repository/server/api/core/
 handle_url_prefix = "http://hdl.handle.net/"
 handle_redirect_url_prefix = "https://lindat.mff.cuni.cz/repository/items/"
 
-# OUTPUTFILE(s) directories
-outfile_pathprefix = "./etc/"
+TOOLS_DIR = Path(__file__).resolve().parent
+OUTPUT_DIR = TOOLS_DIR / "etc"
 citation_outfile_name = "citation-{rev}"
 description_outfile_name = "description-{rev}"
-release_handle_map_file = Path(__file__).parent / "etc" / "ud_release_handles.tsv"
+release_handle_map_file = OUTPUT_DIR / "ud_release_handles.tsv"
 
 def load_release_handles(path: Path) -> dict[str, str]:
     """
@@ -73,6 +73,8 @@ try:
 except (OSError, ValueError) as e:
     raise SystemExit(f"Failed to load release-handle mapping from {release_handle_map_file}: {e}")
 
+OUTPUT_DIR.mkdir(parents=True, exist_ok=True)
+
 # Iterate over the URL postfixes
 for rev,handle in url_postfixes.items():
 
@@ -98,9 +100,9 @@ for rev,handle in url_postfixes.items():
                             metadata.split("\n")])
 
                 # Open the output file in write mode
-                output_fn = f"{outfile_pathprefix}"+citation_outfile_name.format(rev=rev)
-                if args.override or not Path(output_fn).exists():
-                    with open(output_fn, "w") as fh:
+                output_fn = OUTPUT_DIR / citation_outfile_name.format(rev=rev)
+                if args.override or not output_fn.exists():
+                    with output_fn.open("w") as fh:
                         fh.write(metadata + "\n")
                         logging.info(f"Successfully downloaded citation from {citation_url} and written to {output_fn}.")
                 else:
@@ -122,9 +124,9 @@ for rev,handle in url_postfixes.items():
                     if description:
 
                         # Open the output file in write mode
-                        output_fn = f"{outfile_pathprefix}"+description_outfile_name.format(rev=rev)
-                        if args.override or not Path(output_fn).exists():
-                            with open(output_fn, "w") as fh:
+                        output_fn = OUTPUT_DIR / description_outfile_name.format(rev=rev)
+                        if args.override or not output_fn.exists():
+                            with output_fn.open("w") as fh:
                                 fh.write(description+ "\n")
                                 logging.info(f"Successfully downloaded description from {description_url} and written to {output_fn}.")
                         else:

tools/01_fetch_ud_snapshot.sh

@@ -9,15 +9,17 @@
 
 set -euo pipefail
 
-[ -e .env ] && . .env
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+ENV_FILE="${SCRIPT_DIR}/.env"
+HANDLE_MAP_FILE="${SCRIPT_DIR}/etc/ud_release_handles.tsv"
+
+[ -e "${ENV_FILE}" ] && . "${ENV_FILE}"
 
 ONLINE_MODE=false
 KEEP_ARCHIVE=false
 KEEP_BACKUP=false
 UD_VER=${UD_VER:-"2.17"}
-UDS_SUBDIR="UD_repos"
-SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-HANDLE_MAP_FILE="${SCRIPT_DIR}/etc/ud_release_handles.tsv"
+UDS_SUBDIR="${SCRIPT_DIR}/UD_repos"
 
 ###################
 #############
@@ -94,8 +96,9 @@ if [[ -z "${HANDLE}" ]]; then
     exit 1
 fi
 
-SNAPSHOT_DIR="ud-treebanks-v${UD_VER}"
-SNAPSHOT_ARCHIVE="${SNAPSHOT_DIR}.zip"
+SNAPSHOT_DIR_NAME="ud-treebanks-v${UD_VER}"
+SNAPSHOT_DIR="${SCRIPT_DIR}/${SNAPSHOT_DIR_NAME}"
+SNAPSHOT_ARCHIVE="${SCRIPT_DIR}/${SNAPSHOT_DIR_NAME}.zip"
 SNAPSHOT_URL="https://hdl.handle.net/${HANDLE}/allzip"
 
 download_snapshot() {
@@ -117,7 +120,7 @@ PY
 extract_snapshot() {
     local tmp_dir backup_dir
     tmp_dir=$(mktemp -d)
-    echo "Extracting ${SNAPSHOT_ARCHIVE} into ${SNAPSHOT_DIR}"
+    echo "Extracting ${SNAPSHOT_ARCHIVE} into ${SNAPSHOT_DIR_NAME}"
 
     if command -v unzip >/dev/null 2>&1; then
         unzip -q "${SNAPSHOT_ARCHIVE}" -d "${tmp_dir}"
@@ -141,10 +144,10 @@ PY
     if [[ -d "${SNAPSHOT_DIR}" ]]; then
         if [[ "${KEEP_BACKUP}" == true ]]; then
             backup_dir="${SNAPSHOT_DIR}.bak.$(date +%s)"
-            echo "Existing ${SNAPSHOT_DIR} found; moving it to ${backup_dir}"
+            echo "Existing ${SNAPSHOT_DIR_NAME} found; moving it to ${backup_dir}"
             mv "${SNAPSHOT_DIR}" "${backup_dir}"
         else
-            echo "Existing ${SNAPSHOT_DIR} found; removing it"
+            echo "Existing ${SNAPSHOT_DIR_NAME} found; removing it"
             rm -rf "${SNAPSHOT_DIR}"
         fi
     fi
@@ -161,22 +164,22 @@ if [[ "${ONLINE_MODE}" == true ]] || [[ ! -d "${SNAPSHOT_DIR}" ]]; then
     fi
     extract_snapshot
 else
-    echo "Snapshot directory already exists: ${SNAPSHOT_DIR}"
+    echo "Snapshot directory already exists: ${SNAPSHOT_DIR_NAME}"
 fi
 
 if [[ "${KEEP_ARCHIVE}" != true ]] && [[ -f "${SNAPSHOT_ARCHIVE}" ]]; then
-    echo "Removing archive ${SNAPSHOT_ARCHIVE}"
+    echo "Removing archive ${SNAPSHOT_DIR_NAME}.zip"
     rm -f "${SNAPSHOT_ARCHIVE}"
 fi
 
 if [[ -L "${UDS_SUBDIR}" ]]; then
-    ln -sfn "${SNAPSHOT_DIR}" "${UDS_SUBDIR}"
+    ln -sfn "${SNAPSHOT_DIR_NAME}" "${UDS_SUBDIR}"
 elif [[ ! -e "${UDS_SUBDIR}" ]]; then
-    ln -s "${SNAPSHOT_DIR}" "${UDS_SUBDIR}"
+    ln -s "${SNAPSHOT_DIR_NAME}" "${UDS_SUBDIR}"
 else
     >&2 echo "${UDS_SUBDIR} exists and is not a symlink. Please move/remove it, then rerun."
     exit 1
 fi
 
 echo "UD snapshot ready:"
-echo "  ${UDS_SUBDIR} -> ${SNAPSHOT_DIR}"
+echo "  UD_repos -> ${SNAPSHOT_DIR_NAME}"

tools/02_generate_metadata.py

@@ -20,7 +20,9 @@ import yaml
 from dotenv import load_dotenv
 
 
-load_dotenv()
+TOOLS_DIR = Path(__file__).resolve().parent
+
+load_dotenv(TOOLS_DIR / ".env")
 UD_VER = os.getenv('UD_VER', "2.15")
 
 # Parse command line arguments
@@ -149,7 +151,8 @@ def traverse_directory(directory):
     """
     results = defaultdict(lambda: defaultdict(dict))
 
-    with open(os.path.join('etc', f"codes_and_flags-{UD_VER}.yaml"), 'r') as file:
+    codes_and_flags_path = TOOLS_DIR / "etc" / f"codes_and_flags-{UD_VER}.yaml"
+    with codes_and_flags_path.open('r') as file:
         codes_and_flags = yaml.safe_load(file)
         logging.debug(codes_and_flags)
 
@@ -266,19 +269,19 @@ def traverse_directory(directory):
                     del results[item]["splits"][fileset_k]
 
             #   2. sets without a summary, files or license
-            if not results[item]["summary"]:
-                del results[item]
-                logging.warning("ITEM DELETED - no summary: %s", item)
-
-            if not any([value["files"] for value in
-                        results[item]["splits"].values()]):
-                logging.debug(results[item]["splits"])
-                del results[item]
-                logging.warning("ITEM DELETED - no files: %s", item)
-
-            if not results[item]["license"]:
+            missing_summary = not results[item]["summary"]
+            missing_files = not any(value["files"] for value in results[item]["splits"].values())
+            missing_license = not results[item]["license"]
+
+            if missing_summary or missing_files or missing_license:
+                if missing_summary:
+                    logging.warning("ITEM DELETED - no summary: %s", item)
+                if missing_files:
+                    logging.debug(results[item]["splits"])
+                    logging.warning("ITEM DELETED - no files: %s", item)
+                if missing_license:
+                    logging.warning("ITEM DELETED - no license: %s", item)
                 del results[item]
-                logging.warning("ITEM DELETED - no license: %s", item)
 
     # Swap keys and key.value()["name"]; add old key as key.value()["dirname"]
     for key in list(results.keys()):
@@ -290,11 +293,11 @@ def traverse_directory(directory):
     return results
 
 if __name__ == '__main__':
-    directory = 'UD_repos'
+    directory = TOOLS_DIR / 'UD_repos'
     results = traverse_directory(directory)
 
     # Load blocked treebanks and add "blocked" property
-    blocked_treebanks_file = Path('blocked_treebanks.yaml')
+    blocked_treebanks_file = TOOLS_DIR / 'blocked_treebanks.yaml'
     if blocked_treebanks_file.exists():
         with open(blocked_treebanks_file, 'r') as fh:
             blocked_data = yaml.safe_load(fh)
@@ -320,13 +323,12 @@ if __name__ == '__main__':
         logging.debug("Directory: %s", metadata["dirname"])
 
     # Write the metadata to json
-    output_fn = f"metadata-{UD_VER}.json"
-    output_path = Path(output_fn)
+    output_path = TOOLS_DIR / f"metadata-{UD_VER}.json"
     should_write = args.override or (not output_path.exists()) or output_path.stat().st_size == 0
     if should_write:
-        with open(output_fn, 'w') as fh:
+        with output_path.open('w') as fh:
             json.dump(results, fh, ensure_ascii=False, sort_keys=True,
                       indent=4, separators=(',', ': '))
-            print(f"{output_fn} written")
+            print(f"{output_path.name} written")
     else:
-        logging.info(f"Output {output_fn} already exists: Not overriding.")
+        logging.info("Output %s already exists: Not overriding.", output_path.name)

tools/03_generate_README.py

@@ -13,7 +13,9 @@ import jinja2
 from dotenv import load_dotenv
 
 
-load_dotenv()
+TOOLS_DIR = Path(__file__).resolve().parent
+
+load_dotenv(TOOLS_DIR / ".env")
 UD_VER = getenv('UD_VER', "2.15")
 
 # Parse command line arguments
@@ -34,21 +36,19 @@ logging.basicConfig(
 
 
 if __name__ == '__main__':
-    basepath = Path(__file__).parent.relative_to(Path.cwd())
-
     # Read the metadata from json
-    with Path(basepath, f"metadata-{UD_VER}.json").open(mode='r') as fh:
+    with Path(TOOLS_DIR, f"metadata-{UD_VER}.json").open(mode='r') as fh:
         metadata = json.load(fh)
 
-    with Path(basepath, "etc", f"description-{UD_VER}").open(mode='r') as fh:
+    with Path(TOOLS_DIR, "etc", f"description-{UD_VER}").open(mode='r') as fh:
         description = (fh.read()).strip()
 
-    with Path(basepath, "etc", f"citation-{UD_VER}").open(mode='r') as fh:
+    with Path(TOOLS_DIR, "etc", f"citation-{UD_VER}").open(mode='r') as fh:
         citation = (fh.read()).strip()
 
     # Generate README from template
-    template_fn = Path(basepath, "templates", "README.tmpl")
-    output_fn = Path(basepath, f"README-{UD_VER}")
+    template_fn = Path(TOOLS_DIR, "templates", "README.tmpl")
+    output_fn = Path(TOOLS_DIR, f"README-{UD_VER}")
 
     if args.override or not output_fn.exists():
         with template_fn.open(mode='r') as fh:
@@ -59,6 +59,6 @@ if __name__ == '__main__':
                                      description=description,
                                      data=metadata, ud_ver=UD_VER,)
             fh.write(output)
-            print(f"{output_fn} written")
+            print(f"{output_fn.name} written")
     else:
-        logging.info(f"Output {output_fn} already exists: Not overriding.")
+        logging.info("Output %s already exists: Not overriding.", output_fn.name)

tools/04_generate_parquet.py

@@ -29,6 +29,7 @@ Note for developers:
 import argparse
 import os
 import sys
+from pathlib import Path
 
 from dotenv import load_dotenv
 from _ud_hfp_wrapper import (
@@ -39,8 +40,8 @@ from _ud_hfp_wrapper import (
 )
 
 
-# Load environment variables
-load_dotenv()
+# Load environment variables from tools/.env
+load_dotenv(Path(__file__).with_name(".env"))
 UD_VER = os.getenv("UD_VER", "2.17")
 
 # Project paths
@@ -60,6 +61,8 @@ def main():
     parser.add_argument("-q", "--quiet", action="store_true", help="Quiet mode")
 
     args = parser.parse_args()
+    versioned_metadata = Path(__file__).resolve().parent / f"metadata-{UD_VER}.json"
+    metadata_path = versioned_metadata if versioned_metadata.exists() else PATHS.metadata_file
 
     # Use default blocked treebanks file if not specified
     blocked_treebanks_path = args.blocked_treebanks or str(PATHS.blocked_treebanks_file)
@@ -68,7 +71,7 @@ def main():
     tool_args = [
         "ud-hfp-tools",
         "generate",
-        "--metadata", str(PATHS.metadata_file),
+        "--metadata", str(metadata_path),
         "--ud-repos-dir", str(PATHS.ud_repos_dir),
         "--output-dir", str(PATHS.parquet_dir),
         "--blocked-treebanks", blocked_treebanks_path,

tools/05_validate_parquet.py

@@ -45,6 +45,7 @@ Note for developers:
 import argparse
 import os
 import sys
+from pathlib import Path
 
 from dotenv import load_dotenv
 from _ud_hfp_wrapper import (
@@ -55,8 +56,8 @@ from _ud_hfp_wrapper import (
 )
 
 
-# Load environment variables
-load_dotenv()
+# Load environment variables from tools/.env
+load_dotenv(Path(__file__).with_name(".env"))
 UD_VER = os.getenv("UD_VER", "2.17")
 
 # Project paths
@@ -79,7 +80,9 @@ def main():
     parser.add_argument("-q", "--quiet", action="store_true", help="Quiet mode")
 
     args = parser.parse_args()
-    metadata_path = args.metadata or str(PATHS.metadata_file)
+    versioned_metadata = Path(__file__).resolve().parent / f"metadata-{UD_VER}.json"
+    default_metadata = versioned_metadata if versioned_metadata.exists() else PATHS.metadata_file
+    metadata_path = args.metadata or str(default_metadata)
 
     # Build arguments for ud-hf-parquet-tools
     tool_args = [

tools/README.md

@@ -73,6 +73,7 @@ git add ../parquet ../README.md ../metadata.json
 - Wrapper script calling `ud-hf-parquet-tools` library
 - Converts CoNLL-U files to Parquet format
 - Creates: `../parquet/{treebank}/{split}.parquet`
+- Uses `tools/metadata-{UD_VER}.json` when present; otherwise falls back to `../metadata.json`
 - Options: `--test`, `--overwrite`, `--blocked-treebanks`
 
 ### 05 - Validate Parquet
@@ -80,7 +81,8 @@ git add ../parquet ../README.md ../metadata.json
 **05_validate_parquet.py**
 - Wrapper script calling `ud-hf-parquet-tools` library
 - Validates Parquet files against CoNLL-U source
-- Options: `--local`, `--test`, `--mode text`
+- Uses `tools/metadata-{UD_VER}.json` when present; otherwise falls back to `../metadata.json`
+- Options: `--local`, `--parquet-dir`, `--revision`, `--test`, `-vv`
 
 ## Directory Structure