feat: ✨ download REDCap data dictionary script

pyproject.toml

@@ -24,6 +24,8 @@ license-files = ["LICENSE-MIT.md"]
 requires-python = ">=3.12"
 dependencies = [
     "polars>=1.36.0",
+    "python-dotenv>=1.2.2",
+    "requests>=2.32.5",
     "seedcase-sprout>=0.49.0",
 ]
 
@@ -36,5 +38,6 @@ dev = [
     "commitizen>=4.10.0",
     "pre-commit>=4.5.0",
     "ruff>=0.14.8",
+    "types-requests>=2.32.4.20260107",
     "typos>=1.40.0",
 ]

scripts/__init__.py

@@ -1 +1,7 @@
 """Processing and build pipeline scripts."""
+
+from .redcap import save_data_dict
+
+__all__ = [
+    "save_data_dict",
+]

scripts/redcap.py

@@ -0,0 +1,34 @@
+import json
+import os
+from pathlib import Path
+
+import requests
+from dotenv import load_dotenv
+
+load_dotenv()
+
+
+def get_data_dict_from_redcap() -> dict[str, str]:
+    """Gets the data dictionary from REDCap."""
+    token = os.environ.get("REDCAP_TOKEN")
+    if not token:
+        raise RuntimeError("REDCAP_TOKEN environment variable is not set.")
+
+    data = {
+        "token": token,
+        "content": "metadata",
+        "format": "json",
+        "returnFormat": "json",
+    }
+    response = requests.post("https://redcap.au.dk/api/", data=data, timeout=30)
+    response.raise_for_status()
+    return response.json()
+
+
+def save_data_dict():
+    """Saves the data dictionary from REDCap to `scripts/data_dictionary.json`."""
+    data_dict = get_data_dict_from_redcap()
+    file_path = Path("scripts") / "data_dictionary.json"
+    file_path.parent.mkdir(exist_ok=True)
+    with open(file_path, "w") as f:
+        json.dump(data_dict, f, indent=2, ensure_ascii=False)