datatrail-cli 1.1.0__tar.gz → 1.2.0__tar.gz

datatrail_cli-1.2.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.2.0"
+}

{datatrail_cli-1.1.0 → datatrail_cli-1.2.0}/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [1.2.0](https://github.com/CHIMEFRB/datatrail-cli/compare/datatrail-cli-v1.1.0...datatrail-cli-v1.2.0) (2026-11-01)
+
+
+### Features
+
+* **workflow:** pull_dataset can pull to a given directory ([7f2da01](https://github.com/CHIMEFRB/datatrail-cli/commit/7f2da01a257668fd3b8efbd916c82d0d4d441340))
+* **workflow:** pull_dataset can pull to a given directory ([ae3bb39](https://github.com/CHIMEFRB/datatrail-cli/commit/ae3bb397ecea15c850fce33b38af6b38f76e44ee))
+
 ## [1.1.0](https://github.com/CHIMEFRB/datatrail-cli/compare/datatrail-cli-v1.0.2...datatrail-cli-v1.1.0) (2026-11-01)
 
 

{datatrail_cli-1.1.0 → datatrail_cli-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: datatrail-cli
-Version: 1.1.0
+Version: 1.2.0
 Summary: CHIME/FRB Datatrail CLI
 Author: CHIME FRB Project Office
 Author-email: Tarik Zegmott <tarik.zegmott@mcgill.ca>

{datatrail_cli-1.1.0 → datatrail_cli-1.2.0}/docs/workflow.md

@@ -27,6 +27,9 @@ work:
   for this site (as `datatrail config init --site <site>`); if there is one for
   another site, the step fails.
 - `verbose`: 1 for INFO (default), 2 for DEBUG.
+- `directory`: where to pull to, created if it isn't there (default: the site's
+  root mount). The files go under it at their Datatrail paths, e.g.
+  `/scratch/data/chime/baseband/raw/...` for `directory: /scratch`.
 
 Results: `scope`, `dataset`, `files` (how many are here) and `directory`.
 

{datatrail_cli-1.1.0 → datatrail_cli-1.2.0}/dtcli/pull.py

@@ -98,6 +98,8 @@ def pull(  # noqa: C901
         if directory is None:
             directory = config["root_mounts"][site]
             logger.info(f"No directory, setting to: {directory}.")
+        # The file paths are added to it as they are, and click drops the slash
+        directory = path.join(directory, "")
     except Exception:
         logger.exception(
             "Configuration Missing!! Run `datatrail config init`.",

{datatrail_cli-1.1.0 → datatrail_cli-1.2.0}/dtcli/workflow.py

@@ -76,6 +76,7 @@ def pull_dataset(
     cores: int = 1,
     site: Optional[str] = None,
     verbose: int = 1,
+    directory: Optional[str] = None,
 ) -> Outcome:
     """Download a dataset, then check that all its files are here.
 
@@ -86,6 +87,9 @@ def pull_dataset(
         site (Optional[str]): Site this runs at; the configuration is created for it
             if there's none. Defaults to the configured site.
         verbose (int): Verbosity: 1=INFO, 2=DEBUG. Defaults to 1.
+        directory (Optional[str]): Directory to pull to, created if it isn't there;
+            the files go under it at their Datatrail paths. Defaults to the site's
+            root mount.
 
     Returns:
         Outcome: Results (scope, dataset, number of files and where they are), no
@@ -96,9 +100,15 @@ def pull_dataset(
             after the pull.
     """
     config = _configure(site)
-    directory = config["root_mounts"][config["site"]]
     dataset = str(dataset)
     args = [scope, dataset, "--force", "--cores", str(cores)] + ["-v"] * verbose
+    if directory:
+        os.makedirs(directory, exist_ok=True)
+        args += ["--directory", directory]
+        # the file paths are added to it as they are
+        directory = os.path.join(directory, "")
+    else:
+        directory = config["root_mounts"][config["site"]]
     _run(pull, args)
 
     files = find_missing_dataset_files(scope, dataset, directory, verbose)

{datatrail_cli-1.1.0 → datatrail_cli-1.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "datatrail-cli"
-version = "1.1.0"
+version = "1.2.0"
 description = "CHIME/FRB Datatrail CLI"
 authors = [
   { name = "CHIME FRB Project Office" },

{datatrail_cli-1.1.0 → datatrail_cli-1.2.0}/tests/test_pull_reliability.py

@@ -274,6 +274,26 @@ def test_pull_exits_nonzero_when_file_is_still_missing(monkeypatch, tmp_path):
     assert "File not downloaded" in result.output
 
 
+def test_pull_checks_a_given_directory_for_existing_files(monkeypatch, tmp_path):
+    """Files already under --directory are found, though click drops its slash."""
+    configure_pull(monkeypatch, tmp_path, lambda *args, **kwargs: [])
+    roots = []
+    monkeypatch.setattr(
+        pull_module,
+        "find_missing_dataset_files",
+        lambda scope, dataset, root, verbose: roots.append(root)
+        or {"missing": [], "existing": ["data/file.dat"]},
+    )
+
+    result = CliRunner().invoke(
+        pull_module.pull,
+        ["scope", "dataset", "--directory", str(tmp_path), "--force"],
+    )
+
+    assert result.exit_code == 0
+    assert roots == [str(tmp_path) + "/"]
+
+
 def test_pull_interruption_exits_nonzero(monkeypatch, tmp_path):
     """An interrupted pull is not reported as successful."""
 

{datatrail_cli-1.1.0 → datatrail_cli-1.2.0}/tests/test_workflow.py

@@ -70,6 +70,32 @@ def test_pull_dataset_returns_workflow_outcome(config, monkeypatch):
     assert products == [] and plots == []
 
 
+def test_pull_dataset_pulls_to_a_given_directory(config, tmp_path, monkeypatch):
+    config.write()
+    pull = FakeCommand("pull")
+    monkeypatch.setattr(workflow, "pull", pull)
+    checked = []
+    monkeypatch.setattr(
+        workflow,
+        "find_missing_dataset_files",
+        lambda scope, dataset, root, verbose: checked.append(root)
+        or {"missing": [], "existing": ["a"]},
+    )
+    scratch = tmp_path / "scratch"
+
+    results, _, _ = workflow.pull_dataset(
+        "scope", "1", site="canfar", directory=str(scratch)
+    )
+
+    assert scratch.is_dir()
+    assert pull.calls == [
+        ["scope", "1", "--force", "--cores", "1", "-v", "--directory", str(scratch)]
+    ]
+    # the files' paths are added to it, so it ends with a slash
+    assert checked == [str(scratch) + "/"]
+    assert results["directory"] == str(scratch) + "/"
+
+
 def test_pull_dataset_creates_the_configuration(config, monkeypatch):
     monkeypatch.setattr(workflow, "pull", FakeCommand("pull"))
     monkeypatch.setattr(

{datatrail_cli-1.1.0 → datatrail_cli-1.2.0}/uv.lock

@@ -508,7 +508,7 @@ wheels = [
 
 [[package]]
 name = "datatrail-cli"
-version = "1.1.0"
+version = "1.2.0"
 source = { editable = "." }
 dependencies = [
     { name = "cadcdata" },

datatrail_cli-1.1.0/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-  ".": "1.1.0"
-}