datatrail-cli 0.12.0__tar.gz → 0.13.0__tar.gz

{datatrail_cli-0.12.0 → datatrail_cli-0.13.0}/.github/workflows/continuous-deployment.yml

@@ -9,20 +9,17 @@ jobs:
     steps:
       - name: Create release
         id: release-please
-        uses: google-github-actions/release-please-action@v3
-        with:
-          release-type: python
-          package-name: datatrail-cli
+        uses: googleapis/release-please-action@v5
 
       - name: Checkout code
         if: ${{ steps.release-please.outputs.release_created }}
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
         with:
           fetch-depth: 1
 
       - name: Install uv
         if: ${{ steps.release-please.outputs.release_created }}
-        uses: astral-sh/setup-uv@v8.3.2
+        uses: astral-sh/setup-uv@v10.0.1
         with:
           enable-cache: false
           python-version: "3.13"

{datatrail_cli-0.12.0 → datatrail_cli-0.13.0}/.github/workflows/continuous-integration.yml

@@ -15,10 +15,10 @@ jobs:
   Pre-commit-checks:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
 
       - name: Set up Python 3.13
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: 3.13
 
@@ -30,6 +30,8 @@ jobs:
   Testing:
     needs: pre-commit-checks
     runs-on: ubuntu-latest
+    env:
+      RUN_CADC_TESTS: ${{ github.repository == 'CHIMEFRB/datatrail-cli' && github.event_name == 'push' && github.ref == 'refs/heads/main' }}
     strategy:
       fail-fast: false
       matrix:
@@ -41,10 +43,10 @@ jobs:
           - "3.13"
           - "3.14"
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v8.3.2
+        uses: astral-sh/setup-uv@v10.0.1
         with:
           enable-cache: true
           cache-dependency-glob: "uv.lock"
@@ -52,30 +54,40 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Installation
-        run: uv sync
+        run: uv sync --locked
 
       - name: Create NETRC file
+        if: env.RUN_CADC_TESTS == 'true'
+        env:
+          CANFAR_NETRC: ${{ secrets.CANFAR_NETRC }}
         run: |
-          export CANFAR_NETRC_FILE=$RUNNER_TEMP"/CANFAR_NETRC"
-          echo ${{ secrets.CANFAR_NETRC }} > $CANFAR_NETRC_FILE
-          echo CANFAR_NETRC_FILE=$CANFAR_NETRC_FILE >> "$GITHUB_ENV"
+          umask 077
+          test -n "$CANFAR_NETRC"
+          printf '%s\n' "$CANFAR_NETRC" > "$RUNNER_TEMP/CANFAR_NETRC"
 
       - name: Obtain CADC certificate
+        if: env.RUN_CADC_TESTS == 'true'
         run: |
-          export CADC_CERT=$HOME"/.ssl/cadcproxy.pem"
-          uv run --no-sync cadc-get-cert --netrc-file ${{ env.CANFAR_NETRC_FILE }} --days-valid 1 --cert-filename $CADC_CERT
-          echo CADC_CERT=$CADC_CERT >> "$GITHUB_ENV"
+          umask 077
+          mkdir -p "$HOME/.ssl"
+          uv run --no-sync cadc-get-cert --netrc-file "$RUNNER_TEMP/CANFAR_NETRC" --days-valid 1 --cert-filename "$HOME/.ssl/cadcproxy.pem"
+          test -s "$HOME/.ssl/cadcproxy.pem"
+          openssl x509 -in "$HOME/.ssl/cadcproxy.pem" -noout -checkend 0
 
-      - name: Run Tests
+      - name: Run tests
+        if: env.RUN_CADC_TESTS == 'true'
         run: |
           uv run --no-sync pytest tests/ --cov . --cov-report=lcov --cov-report=xml
 
+      - name: Run tests without CADC credentials
+        if: env.RUN_CADC_TESTS != 'true'
+        run: |
+          uv run --no-sync pytest tests/ -m "not cadc" --cov . --cov-report=lcov --cov-report=xml
+
       - name: Remove NETRC file and CADC certificate
+        if: ${{ always() && env.RUN_CADC_TESTS == 'true' }}
         run: |
-          echo "Removing file: "$CANFAR_NETRC_FILE
-          rm $CANFAR_NETRC_FILE
-          echo "Removing file: "$CADC_CERT
-          rm $CADC_CERT
+          rm -f -- "$RUNNER_TEMP/CANFAR_NETRC" "$HOME/.ssl/cadcproxy.pem"
 
       - name: Upload coverage to Coveralls
         uses: coverallsapp/github-action@v2

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

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

{datatrail_cli-0.12.0 → datatrail_cli-0.13.0}/CHANGELOG.md

@@ -1,5 +1,137 @@
 # Changelog
 
+## [0.13.0](https://github.com/CHIMEFRB/datatrail-cli/compare/datatrail-cli-v0.12.0...datatrail-cli-v0.13.0) (2026-08-25)
+
+
+### Features
+
+* **clear:** command to unstage data locally or at arc ([#16](https://github.com/CHIMEFRB/datatrail-cli/issues/16)) ([737c781](https://github.com/CHIMEFRB/datatrail-cli/commit/737c7811a6112a46e842bc135d94d035a9bf301f))
+* **clear:** remove empty parent dirs ([#20](https://github.com/CHIMEFRB/datatrail-cli/issues/20)) ([1559608](https://github.com/CHIMEFRB/datatrail-cli/commit/1559608de9d18d1b16a069c5b6b8136afb388fab))
+* **cli:** add unregistered command ([d9a97a5](https://github.com/CHIMEFRB/datatrail-cli/commit/d9a97a53b6f87321c50aec34339d6b5959b5e713))
+* **cli:** add unregistered command ([b33a6fa](https://github.com/CHIMEFRB/datatrail-cli/commit/b33a6fae57ff2bdad6c26f0ed5402994fdef7650))
+* **cli:** aliases ([73ede83](https://github.com/CHIMEFRB/datatrail-cli/commit/73ede838133b54ef0ba8f45eda453547d601a180))
+* **cli:** check scope exists ([f14589b](https://github.com/CHIMEFRB/datatrail-cli/commit/f14589bc539ec3448348d1d6bc9b1b32d864d7ea))
+* **config:** added datatrail config module ([fe04ee1](https://github.com/CHIMEFRB/datatrail-cli/commit/fe04ee1af77e3d416c103e9ef73a7d79a4b616d5))
+* **gh-actions:** ci and cd ([ebb7a96](https://github.com/CHIMEFRB/datatrail-cli/commit/ebb7a966836d2a4f57287191b9396d9b72cb3cfe))
+* **ls & ps:** add --json flag for machine readable output ([75dac4d](https://github.com/CHIMEFRB/datatrail-cli/commit/75dac4da4fc172adebe2b518cf0b6136e201d94d))
+* **ls & ps:** add --json flag for machine readable output ([c4742a0](https://github.com/CHIMEFRB/datatrail-cli/commit/c4742a0dfe43823ce8e68f21e26e146b90db958c)), closes [#159](https://github.com/CHIMEFRB/datatrail-cli/issues/159)
+* **ls,-pull:** partially implemented ([6689d11](https://github.com/CHIMEFRB/datatrail-cli/commit/6689d119782d1e251935050c508fb14969ff33d2))
+* **ls,pull:** fully implemented ([2105f5a](https://github.com/CHIMEFRB/datatrail-cli/commit/2105f5a86dc42a0618903d0e315bc6490fd633ed))
+* **ls:** option to write ls datasets to disk ([513d665](https://github.com/CHIMEFRB/datatrail-cli/commit/513d665a843bb4aa1f6f92e54ab020ee4f1477ab))
+* **ls:** show datasets in given parent dataset ([15f7da1](https://github.com/CHIMEFRB/datatrail-cli/commit/15f7da1aa76a2a0c75f9229e445f96886b353a1f))
+* **ls:** show larger datasets ([344e230](https://github.com/CHIMEFRB/datatrail-cli/commit/344e230f9798ad8a27752431bfd70f73370488f8))
+* **project:** boilerplate added ([43085a1](https://github.com/CHIMEFRB/datatrail-cli/commit/43085a15789c2045ea41bca9aa89c26c26182019))
+* **ps:** function implemented ([6feedde](https://github.com/CHIMEFRB/datatrail-cli/commit/6feedde08b0dddc3c9b43aba17999e681a2c6b1e))
+* **ps:** if no files check if dataset is in unregistered bucket and notify user ([40ed903](https://github.com/CHIMEFRB/datatrail-cli/commit/40ed903623a4ec9fd4043b4d1863626303830a54)), closes [#46](https://github.com/CHIMEFRB/datatrail-cli/issues/46)
+* **ps:** show num files and size by default, flag to show all files ([cccbd33](https://github.com/CHIMEFRB/datatrail-cli/commit/cccbd3337289699f80112edff612abf746407f4b))
+* **pull:** allows specific files to be pulled by designating names o… ([49f186a](https://github.com/CHIMEFRB/datatrail-cli/commit/49f186a6bcdd88e9aad0a863279b06e29b645158))
+* **pull:** allows specific files to be pulled by designating names or paths in a local config file ([d3cfb59](https://github.com/CHIMEFRB/datatrail-cli/commit/d3cfb59906fe4cb13c8f549e8c2b6499c32e663e))
+* **pull:** check all files were downloaded ([eea76ef](https://github.com/CHIMEFRB/datatrail-cli/commit/eea76efb91b2a35f2900be59d4484d02721322da))
+* **pull:** check all files were downloaded ([bb1d8b6](https://github.com/CHIMEFRB/datatrail-cli/commit/bb1d8b64378fe80a27944f8eaccf6ce674ce17d0))
+* **pull:** display size of files to be pulled before prompt ([38cffcc](https://github.com/CHIMEFRB/datatrail-cli/commit/38cffccb18dcaca41150ee7af85b4c80f6137284))
+* **pull:** implemented multiprocessor pull ([2e7b332](https://github.com/CHIMEFRB/datatrail-cli/commit/2e7b33205789c54e4f9544223a0555d74edd464d))
+* **scout:** able to heal missing minoc replicas ([bc3b52d](https://github.com/CHIMEFRB/datatrail-cli/commit/bc3b52d44fe7da7335279c96cec03e3deace6f9a))
+* **scout:** add scout command to the cli ([#83](https://github.com/CHIMEFRB/datatrail-cli/issues/83)) ([5cb811f](https://github.com/CHIMEFRB/datatrail-cli/commit/5cb811f416c6fe099cf2405835ad867df125a62d))
+* **scout:** generalised scout functionality to check for discrepanci… ([aabcad1](https://github.com/CHIMEFRB/datatrail-cli/commit/aabcad1937fef1734ef17593726d27bb673a29ad))
+* **scout:** generalised scout functionality to check for discrepancies between all sites, not just minoc ([f3f1005](https://github.com/CHIMEFRB/datatrail-cli/commit/f3f1005722c48d4ac020b65ed13d19f6bc0bbd48))
+* **structure:** added skeleton code ([c3e57f6](https://github.com/CHIMEFRB/datatrail-cli/commit/c3e57f63ea0e54c45f12a4c3682ed01e5d9489ec))
+* **unregistered:** command to search for event in unregistered results bucket ([1bb4ca0](https://github.com/CHIMEFRB/datatrail-cli/commit/1bb4ca0c118e042a907f38205af5d7ed6bf9f16d))
+
+
+### Bug Fixes
+
+* bound every REST call with a request timeout ([431270d](https://github.com/CHIMEFRB/datatrail-cli/commit/431270d2fb4e59acc8a875b578964d20d2aeebb4))
+* **cadcclient:** check canfar status ([484562c](https://github.com/CHIMEFRB/datatrail-cli/commit/484562c3c8345dd032c00923d3250c1be4a12191))
+* **cadcclient:** improve handling of stdout ([8b35e4f](https://github.com/CHIMEFRB/datatrail-cli/commit/8b35e4f5ccdaf874c706f31a608a89b0612b669d))
+* **cadcclient:** improve handling of stdout ([320d4df](https://github.com/CHIMEFRB/datatrail-cli/commit/320d4dfcdd194aa69f9236c84f21dbfb8690068b))
+* **cadcclient:** more robust switching of stdout ([9c90315](https://github.com/CHIMEFRB/datatrail-cli/commit/9c9031595a9e13d6471e4b5e5edc548a4d1545ad))
+* **ci:** accept request timeout in scopes mock ([1ff9624](https://github.com/CHIMEFRB/datatrail-cli/commit/1ff9624c15045d1acdb30ad471bf6c6a9c298174))
+* **ci:** keep fork main credential-free ([9030bfb](https://github.com/CHIMEFRB/datatrail-cli/commit/9030bfb6d971afdb557772d35b1691f531e5e0b4))
+* **ci:** keep fork main credential-free ([73a4b02](https://github.com/CHIMEFRB/datatrail-cli/commit/73a4b029178db001025ec5442ce9b9a43911615c))
+* **clear:** reorganise file_paths manipulation logic ([fd14f9b](https://github.com/CHIMEFRB/datatrail-cli/commit/fd14f9b714590f1cb57684565cfa23fd7bc8fc52))
+* **clear:** reorganise file_paths manipulation logic ([80f0f2d](https://github.com/CHIMEFRB/datatrail-cli/commit/80f0f2d2bf3d9836eef16f9f6d3bed5f88c8ff05))
+* **cli-test:** new test - marked as fix to trigger release ([aea98d0](https://github.com/CHIMEFRB/datatrail-cli/commit/aea98d07f63ee17f6d5b4acd396ea32e3aefbd11))
+* **cli:** canfar status checks ([7f9df34](https://github.com/CHIMEFRB/datatrail-cli/commit/7f9df349ceeebb1caa7c1c2582cd3d1c54e8ec09))
+* **cli:** catch http 503 errors when validating scope ([b6e75af](https://github.com/CHIMEFRB/datatrail-cli/commit/b6e75affe6db6508882ed5e3da1b22bdec194156))
+* **cli:** check for luskan status ([b229549](https://github.com/CHIMEFRB/datatrail-cli/commit/b2295493c60f0f2a00a95c1c87eb64a0e926b886))
+* **cli:** check for luskan status ([405a3c2](https://github.com/CHIMEFRB/datatrail-cli/commit/405a3c21334b5d8d96ab42436355d8c329880d74))
+* **cli:** check minoc status ([a955ab1](https://github.com/CHIMEFRB/datatrail-cli/commit/a955ab129377dbd62215688598cc2cc434345152))
+* **cli:** check minoc status ([6a0d6df](https://github.com/CHIMEFRB/datatrail-cli/commit/6a0d6dfc4f3490dc407c08d106d7740bb5d892e3))
+* **cli:** print the update-available banner to stderr ([53b9fe4](https://github.com/CHIMEFRB/datatrail-cli/commit/53b9fe4560ff7835a6d7f4e4402538b64f4334aa))
+* **cli:** print the update-available banner to stderr ([8dd6313](https://github.com/CHIMEFRB/datatrail-cli/commit/8dd63139b127cf7219932f9d271482a614dc1261))
+* **cli:** removed pkg resources deprecation warning ([b488b02](https://github.com/CHIMEFRB/datatrail-cli/commit/b488b024c0f6904bc7f6d66ffff8281791cf59c1))
+* **cli:** removed pkg resources deprecation warning ([2ab793d](https://github.com/CHIMEFRB/datatrail-cli/commit/2ab793d753badfd9a2c6aa53ed95010366437c3f))
+* **cli:** updated some docs ([4a61228](https://github.com/CHIMEFRB/datatrail-cli/commit/4a61228300d5082e76081d84520fddf743cc0ebf))
+* **cli:** wrap version check in try except ([2fc9d31](https://github.com/CHIMEFRB/datatrail-cli/commit/2fc9d3169cc28e675c4cfce51aa142b1f22466c4))
+* **config.py:** typo ([#12](https://github.com/CHIMEFRB/datatrail-cli/issues/12)) ([279998b](https://github.com/CHIMEFRB/datatrail-cli/commit/279998bbc5a4c5bd9922db59b159a38fbfdade8b))
+* connection errors raise correct status exit code ([9b4d7bc](https://github.com/CHIMEFRB/datatrail-cli/commit/9b4d7bcc74c6a7c6954d965f8ab421ea6181b016))
+* **functions.py:** added specific handling for canfar site, where the… ([#66](https://github.com/CHIMEFRB/datatrail-cli/issues/66)) ([895a3ca](https://github.com/CHIMEFRB/datatrail-cli/commit/895a3ca7bdb7000847313ef12fe17e50ad7308c8))
+* **functions.py:** changed error catching checks to be for dictionaries with error keys in them as opposed to strings ([#74](https://github.com/CHIMEFRB/datatrail-cli/issues/74)) ([6fdb244](https://github.com/CHIMEFRB/datatrail-cli/commit/6fdb244e46a62253f4654681ec5e5d76431f49f0))
+* **functions.py:** patches deletion logic to check that the path to be deleted is greater than 3 levels deep ([#64](https://github.com/CHIMEFRB/datatrail-cli/issues/64)) ([ad43f35](https://github.com/CHIMEFRB/datatrail-cli/commit/ad43f35ce7b8fbc87210ca93df4433b3c4bbe06d))
+* **functions:** bug ([f4e3788](https://github.com/CHIMEFRB/datatrail-cli/commit/f4e3788944e5a95f868e139369abdfac35c61caa))
+* **functions:** changed return of find_missing_datasets to always ret… ([#76](https://github.com/CHIMEFRB/datatrail-cli/issues/76)) ([a8c0f3d](https://github.com/CHIMEFRB/datatrail-cli/commit/a8c0f3ded414c4e8d4fbca9529bfda7610531841))
+* **init:** set valid choices for datatrail config init ([63f96c3](https://github.com/CHIMEFRB/datatrail-cli/commit/63f96c30c07be1d787381e5457021e805ea0cc6f))
+* **ls:** other section for scopes that don't match list of sites ([0b50d79](https://github.com/CHIMEFRB/datatrail-cli/commit/0b50d790fbfb21fa0edb16eb945722189333a1c2))
+* **ls:** report an unanswered scopes query as an error instead of leaking response text ([6eedaa3](https://github.com/CHIMEFRB/datatrail-cli/commit/6eedaa3720e1f86518fb3ba0292983020affa5af))
+* **ls:** report an unanswered scopes query as an error instead of leaking response text ([8fb77d6](https://github.com/CHIMEFRB/datatrail-cli/commit/8fb77d6d1fbb2d724fbec73f84f4768a4d515181))
+* **ls:** seperate scopes by site ([5bddcc7](https://github.com/CHIMEFRB/datatrail-cli/commit/5bddcc7b368fa0594128f0f7fcb0b2e26959d77e))
+* **ls:** show all larger datasets for scope ([cda63ac](https://github.com/CHIMEFRB/datatrail-cli/commit/cda63ac3053912aa0f4f0bc4781773e3ce46ac0a)), closes [#1](https://github.com/CHIMEFRB/datatrail-cli/issues/1)
+* **ps-and-pull:** check if namespace already prepended ([#9](https://github.com/CHIMEFRB/datatrail-cli/issues/9)) ([eba7532](https://github.com/CHIMEFRB/datatrail-cli/commit/eba7532f3a2c23854a62842f3ce54246916e0d6b))
+* **ps-and-pull:** determination of common path ([a35bbad](https://github.com/CHIMEFRB/datatrail-cli/commit/a35bbad705b9702812281539516e2c7081a9516e)), closes [#19](https://github.com/CHIMEFRB/datatrail-cli/issues/19)
+* **ps.py:** added error handling for returned strings ([#79](https://github.com/CHIMEFRB/datatrail-cli/issues/79)) ([0b3c5b6](https://github.com/CHIMEFRB/datatrail-cli/commit/0b3c5b6f95da361c080534f0e34132172300b956))
+* **ps:** belongs_to cannot be none must be empty string ([#69](https://github.com/CHIMEFRB/datatrail-cli/issues/69)) ([b348dbd](https://github.com/CHIMEFRB/datatrail-cli/commit/b348dbdaa94e106f9c55be006b572566155d2be6))
+* **ps:** bug where common path was not the parent dir of file ([3ba1969](https://github.com/CHIMEFRB/datatrail-cli/commit/3ba1969fec4aa5a57e5913a74d5d6aa10a7d86d7))
+* **ps:** common path bug ([266cc3a](https://github.com/CHIMEFRB/datatrail-cli/commit/266cc3af3d3c397e83c9e18bad39ea5178b191f8))
+* **ps:** controlled error if dataset doesnt exist in datatrail ([09a9d13](https://github.com/CHIMEFRB/datatrail-cli/commit/09a9d13a879971b65902ea19c3b2cda8ce7289de))
+* **ps:** if parent dataset show only policies ([99b4bdd](https://github.com/CHIMEFRB/datatrail-cli/commit/99b4bddfbb788f6617dce408342232e0aa411156))
+* **ps:** invalid scopes, valid scopes are now shown after error message ([5347137](https://github.com/CHIMEFRB/datatrail-cli/commit/534713782fe5105055506d55f1f43c51c110a4b4))
+* **ps:** shows multiple larger datasets in belongs to ([6b32903](https://github.com/CHIMEFRB/datatrail-cli/commit/6b32903007a77f4d8539659870dacbcd94e67f18))
+* **pull:** catch errors when no files at minoc ([fd34637](https://github.com/CHIMEFRB/datatrail-cli/commit/fd346373a3cdab93d0532a82cef5a8a04940aea7))
+* **pull:** default directory ([da6a41d](https://github.com/CHIMEFRB/datatrail-cli/commit/da6a41d9c1dce3613996f735fef65ed62bbcc302))
+* **pull:** FileNotFoundError stopping download ([#15](https://github.com/CHIMEFRB/datatrail-cli/issues/15)) ([cdee724](https://github.com/CHIMEFRB/datatrail-cli/commit/cdee7248d28a94c8bd4cabe3df9c93a337342dd3))
+* **pull:** more processors than files bug ([0536326](https://github.com/CHIMEFRB/datatrail-cli/commit/053632632fd55cb5bba4fe7ce1d398148e0c9cba))
+* **pull:** more processors than files bug ([e44bbe1](https://github.com/CHIMEFRB/datatrail-cli/commit/e44bbe1a14900f034f998b664c1d394fcf31c7a7)), closes [#147](https://github.com/CHIMEFRB/datatrail-cli/issues/147)
+* **pull:** set group permissions if site is canfar ([70236ae](https://github.com/CHIMEFRB/datatrail-cli/commit/70236ae21c0e324d153be89dcead87489b77e5e5))
+* **pull:** wrap download in tenacity retry ([ebdf5b1](https://github.com/CHIMEFRB/datatrail-cli/commit/ebdf5b10489b6a33937576850d57d05b1c1eefcb))
+* **pull:** wrap download in tenacity retry ([8253157](https://github.com/CHIMEFRB/datatrail-cli/commit/8253157e78e1f0abb71fe71fb396b72d1ba51911))
+* **scout:** change order of the args ([d5c33b8](https://github.com/CHIMEFRB/datatrail-cli/commit/d5c33b8ab8a5204fb63f1eb9744d1aa6d5c1f5d1))
+* **scout:** change the order of the arguments ([c7ab294](https://github.com/CHIMEFRB/datatrail-cli/commit/c7ab29459707be153d12f1ff562cf46b984ed519))
+* **scout:** improve error handling ([#87](https://github.com/CHIMEFRB/datatrail-cli/issues/87)) ([1937e9b](https://github.com/CHIMEFRB/datatrail-cli/commit/1937e9bbedfda0ab11919428b0b1b027900f594d))
+* **test:** changed docstring expected in help test ([fed9342](https://github.com/CHIMEFRB/datatrail-cli/commit/fed9342df20b6843171a8cb4b288899ada74e261))
+* **timeout:** bound every REST call with a request timeout ([fb533a2](https://github.com/CHIMEFRB/datatrail-cli/commit/fb533a2487c744fd18da4857b9ab74bea4615459))
+* **unregistered:** improve pattern matching ([22ff11a](https://github.com/CHIMEFRB/datatrail-cli/commit/22ff11aa6d8aa390e465bf0ef62065f288f05bac))
+* **unregistered:** improve way info displayed ([21e19a7](https://github.com/CHIMEFRB/datatrail-cli/commit/21e19a7ea239667ac882b1d8fbff57a145989227))
+* **unregistered:** improve way info displayed ([c5f0fca](https://github.com/CHIMEFRB/datatrail-cli/commit/c5f0fca6f6f53e5004e1f1868517100572d68d1a))
+* Update cadcdata to version 2.5 ([#58](https://github.com/CHIMEFRB/datatrail-cli/issues/58)) ([8ed6ad3](https://github.com/CHIMEFRB/datatrail-cli/commit/8ed6ad3914850483d147f0605809c1dd76363403))
+* **version:** color ([ac2c7be](https://github.com/CHIMEFRB/datatrail-cli/commit/ac2c7bea886f48cc5fa5b84443999fb6e3809461))
+
+
+### Documentation
+
+* add unregistered command ([d8dd35b](https://github.com/CHIMEFRB/datatrail-cli/commit/d8dd35b22069b69ff7e3e76b6dc935696f8c2840))
+* **all-docs:** revamp and additional content ([697fa6f](https://github.com/CHIMEFRB/datatrail-cli/commit/697fa6f2d2e150414c034c9d45a461808cd87381))
+* **cli:** started docs ([f1838d5](https://github.com/CHIMEFRB/datatrail-cli/commit/f1838d5864cfed16e5221e9b5affaebb39ec108d))
+* **gh-action:** build docs ([0698516](https://github.com/CHIMEFRB/datatrail-cli/commit/0698516e1670fb7a019ac271707d1d40fa4c5904))
+* **gh-action:** install without dev ([0ea4a92](https://github.com/CHIMEFRB/datatrail-cli/commit/0ea4a92395c4eb04e6e6913679c3fd9b1b0cbd56))
+* **gh-actions:** fix python version ([6db8c76](https://github.com/CHIMEFRB/datatrail-cli/commit/6db8c76298da316b7614d9ce794154ce75b83939))
+* **index.md:** allow comments ([c680000](https://github.com/CHIMEFRB/datatrail-cli/commit/c6800007925c5794a5f7c29a63934c904cdaea07))
+* **index:** add clear command ([01fcfb5](https://github.com/CHIMEFRB/datatrail-cli/commit/01fcfb5df89a8c567f743c26cc2342ccad93c632))
+* **index:** badge ([09c637e](https://github.com/CHIMEFRB/datatrail-cli/commit/09c637eea007d0176a0ca0abe7524ca9f5c8a667))
+* **index:** rewording ([6e7b2d1](https://github.com/CHIMEFRB/datatrail-cli/commit/6e7b2d1985233595374dc6d311b7b34389f92344))
+* **index:** small fixes ([6483813](https://github.com/CHIMEFRB/datatrail-cli/commit/6483813033d71281a973dc52d250ae4e37a2df9e))
+* **index:** update commands available ([aec676d](https://github.com/CHIMEFRB/datatrail-cli/commit/aec676d576082e288ee7144c39e34eb289dc8946))
+* **index:** update install instructions ([fd7f51c](https://github.com/CHIMEFRB/datatrail-cli/commit/fd7f51c64d8f4b97f23d2b2b5897b34809a1bee3))
+* **list:** test terminal plug in ([2cb4bc0](https://github.com/CHIMEFRB/datatrail-cli/commit/2cb4bc00ae89bdd1a7321ca2bd887da556225641))
+* **README-and-index:** updated ([97353b3](https://github.com/CHIMEFRB/datatrail-cli/commit/97353b3c7f94a199363853b1622b930064ea085f))
+* **scout:** added for new cli command ([be4f2bf](https://github.com/CHIMEFRB/datatrail-cli/commit/be4f2bfda25000b453b9696b2137e6bf0e8e4dd6))
+* **scout:** reflect changes to cli in docs ([797eeac](https://github.com/CHIMEFRB/datatrail-cli/commit/797eeac4874619298c22f8f8a7623e079ac6542d))
+* **scout:** typos ([7f633b1](https://github.com/CHIMEFRB/datatrail-cli/commit/7f633b17d514303d260990e1ece849d1c489ef91))
+* **style:** use termynal ([e908d47](https://github.com/CHIMEFRB/datatrail-cli/commit/e908d4786e63972bef9f712b6c740088c8ac7906))
+* update mkdocs config + ci/cd ([3a1014e](https://github.com/CHIMEFRB/datatrail-cli/commit/3a1014e75b0639f991cb49baf826bd925455b2f4))
+* update mkdocs config + ci/cd ([0e4bee0](https://github.com/CHIMEFRB/datatrail-cli/commit/0e4bee0efbf9cd28fe4964497b5b0b7492efc3c2))
+* **user-guide:** command highlights ([6813964](https://github.com/CHIMEFRB/datatrail-cli/commit/6813964e361391a8cbd4558b7c9bcda32c42cd7c))
+* **user-guide:** completed ([a25ac76](https://github.com/CHIMEFRB/datatrail-cli/commit/a25ac767f8fee8bb22d100358481090c186f8e1f))
+
 ## [0.12.0](https://github.com/CHIMEFRB/datatrail-cli/compare/v0.11.1...v0.12.0) (2026-08-24)
 
 

{datatrail_cli-0.12.0 → datatrail_cli-0.13.0}/PKG-INFO

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

{datatrail_cli-0.12.0 → datatrail_cli-0.13.0}/dtcli/cli.py

@@ -11,6 +11,7 @@ from dtcli.utilities import utilities
 
 pretty.install()
 terminal = console.Console()
+terminal_stderr = console.Console(stderr=True)
 
 
 # Main CLI
@@ -50,15 +51,19 @@ cli.add_command(unregistered.unregistered)
 
 
 def check_version() -> None:
-    """Check if CLI is latest release."""
+    """Check if CLI is latest release.
+
+    The banner goes to stderr so that stdout stays parseable, e.g. for
+    `--json` output piped into another tool.
+    """
     if not utilities.cli_is_latest_release():
         current_version = package_version("datatrail-cli")
         latest_version = utilities.get_latest_released_version()
-        terminal.print(
+        terminal_stderr.print(
             f"A new release of datatrail-cli is available: {current_version} → {latest_version}",  # noqa: E501
             style="bold yellow",
         )
-        terminal.print()
+        terminal_stderr.print()
 
 
 if __name__ == "__main__":

{datatrail_cli-0.12.0 → datatrail_cli-0.13.0}/dtcli/scout.py

@@ -13,7 +13,12 @@ from rich.table import Table
 from dtcli.config import procure
 from dtcli.ls import list as ls
 from dtcli.utilities import cadcclient
-from dtcli.utilities.utilities import check_canfar_status, set_log_level, validate_scope
+from dtcli.utilities.utilities import (
+    REQUEST_TIMEOUT,
+    check_canfar_status,
+    set_log_level,
+    validate_scope,
+)
 
 logger = logging.getLogger("scout")
 
@@ -89,7 +94,11 @@ def scout(  # noqa: C901
     )
     url = server + endpoint
     logger.debug(f"URL: {url}")
-    response = requests.get(url)
+    try:
+        response = requests.get(url, timeout=REQUEST_TIMEOUT)
+    except requests.exceptions.Timeout:
+        error_console.print("Error: Datatrail server timed out.")
+        return None
     try:
         data = response.json()
         logger.debug(f"Data: {data}")
@@ -160,14 +169,22 @@ def scout(  # noqa: C901
                     + "/query/datasset/scout/md5sums"
                     + f"?basepath={basepath}&site={se}&filetype={file_type}"
                 )
-                response = requests.get(md5_url)
+                try:
+                    response = requests.get(md5_url, timeout=REQUEST_TIMEOUT)
+                except requests.exceptions.Timeout:
+                    error_console.print(f"{scope} - Healing timed out; skipping.")
+                    continue
                 file_md5s = response.json()
             url = (
                 server
                 + "/commit/dataset/scout/sync"
                 + f"?name={dataset}&scope={scope}&replicate_to={se}"
             )
-            response = requests.post(url, json=file_md5s)
+            try:
+                response = requests.post(url, json=file_md5s, timeout=REQUEST_TIMEOUT)
+            except requests.exceptions.Timeout:
+                error_console.print(f"{scope} - Healing timed out; skipping.")
+                continue
             if response.status_code == 200:
                 console.print(f"{scope} - Healing successful.")
             else:

{datatrail_cli-0.12.0 → datatrail_cli-0.13.0}/dtcli/src/functions.py

@@ -7,6 +7,7 @@ import shutil
 import subprocess
 import time
 from collections import Counter
+from collections.abc import Sequence
 from pathlib import Path
 from typing import Any, Dict, List, Optional, Tuple
 
@@ -54,10 +55,21 @@ def list(  # noqa: C901
         logger.info("Finding all scopes in Datatrail.")
         try:
             url = server + "/query/dataset/scopes"
-            r = requests.get(url)
+            r = requests.get(url, timeout=utilities.REQUEST_TIMEOUT)
             response = utilities.decode_response(r)
+            if isinstance(response, str) or not isinstance(response, Sequence):
+                # decode_response passes a non-JSON body (a proxy error page,
+                # a 5xx message) through as text; report it, or any other
+                # non-list shape, as an error instead of presenting it as
+                # the scopes list. NB: the builtin list is shadowed by this
+                # module's list(), hence the Sequence check.
+                logger.error(f"Scopes query not answered: {response}")
+                return {"error": "Datatrail did not answer the scopes query."}
             return {"scopes": response}
-        except requests.exceptions.ConnectionError as e:
+        except (
+            requests.exceptions.ConnectionError,
+            requests.exceptions.Timeout,
+        ) as e:
             logger.error(e)
             return {"error": "Datatrail Server at CHIME is not responding."}
 
@@ -69,13 +81,16 @@ def list(  # noqa: C901
         logger.info("Finding all larger datasets in Datatrail.")
         try:
             url = server + f"/query/dataset/larger?scope={scope}"
-            r = requests.get(url)
+            r = requests.get(url, timeout=utilities.REQUEST_TIMEOUT)
             response = utilities.decode_response(r)
             if isinstance(response, dict):
                 return response
             else:
                 raise requests.exceptions.ConnectionError(response)
-        except requests.exceptions.ConnectionError as error:
+        except (
+            requests.exceptions.ConnectionError,
+            requests.exceptions.Timeout,
+        ) as error:
             logger.error(error)
             return {"error": f"{error}"}
 
@@ -85,7 +100,7 @@ def list(  # noqa: C901
         try:
             url = server + f"/query/dataset/children/{scope}/{dataset}"
             logger.debug(f"URL: {url}")
-            r = requests.get(url)
+            r = requests.get(url, timeout=utilities.REQUEST_TIMEOUT)
             logger.debug(f"Status: {r.status_code}.")
             response = utilities.decode_response(r)
             logger.debug(f"Reponse: {response}")
@@ -143,7 +158,7 @@ def ps(
         logger.info(f"Getting policy for {dataset} in {scope}.")
         url: str = str(base_url) + f"/query/dataset/{scope}/{dataset}"
         logger.debug(f"URL: {url}")
-        r = requests.get(url)
+        r = requests.get(url, timeout=utilities.REQUEST_TIMEOUT)
         logger.debug(f"Status: {r.status_code}.")
         policy_response = utilities.decode_response(r)
         utilities.validate_request_response(policy_response, dataset, scope)
@@ -192,7 +207,7 @@ def get_dataset_file_info(
         logger.debug(f"Payload: {payload}")
         url = str(base_url) + "/query/dataset/find"
         logger.debug(f"URL: {url}")
-        r = requests.post(url, json=payload)
+        r = requests.post(url, json=payload, timeout=utilities.REQUEST_TIMEOUT)
         logger.debug(f"Status: {r.status_code}.")
         logger.debug("Decoding response.")
         response = utilities.decode_response(r)
@@ -403,7 +418,7 @@ def find_dataset_common_path(
     url = server + "/query/dataset/find"
     logger.debug(f"URL: {url}")
     try:
-        r = requests.post(url, json=payload)
+        r = requests.post(url, json=payload, timeout=utilities.REQUEST_TIMEOUT)
         dataset_locations = utilities.decode_response(r)  # type: ignore
         utilities.validate_request_response(dataset_locations, dataset, scope)
     except ConnectionError:
@@ -455,6 +470,7 @@ def view_results(
             "projection": projection,
             "limit": limit,
         },
+        timeout=utilities.REQUEST_TIMEOUT,
     )
     return response.json()
 

{datatrail_cli-0.12.0 → datatrail_cli-0.13.0}/dtcli/utilities/cadcclient.py

@@ -416,15 +416,19 @@ def status(
         certfile = procure(key="vospace_certfile")
 
     def check_url(url: str) -> bool:
-        response = requests.get(url, cert=certfile, allow_redirects=True)
         try:
+            # Health probe: fail fast, and read a wedged or unreachable
+            # endpoint as "down" rather than crashing the caller.
+            response = requests.get(
+                url, cert=certfile, allow_redirects=True, timeout=(10, 30)
+            )
             response.raise_for_status()
             authorised = response.headers.get("x-vo-authenticated")
             if isinstance(authorised, str):
                 return True
             else:
                 raise TypeError
-        except HTTPError as error:
+        except (HTTPError, requests.exceptions.RequestException) as error:
             logger.warning(error)
             logger.warning(f"{url.split('/')[3]} is down.")
             return False

{datatrail_cli-0.12.0 → datatrail_cli-0.13.0}/dtcli/utilities/utilities.py

@@ -13,6 +13,11 @@ try:
 except ImportError:
     from pip._vendor.packaging.version import parse
 
+# Bound every REST call: a wedged connection should fail, not hang forever.
+# (connect, read): fail an unreachable host quickly; keep the read bound
+# generous, because some server-side queries are legitimately slow.
+REQUEST_TIMEOUT: Tuple[float, float] = (10.0, 300.0)
+
 
 def set_log_level(logger: logging.Logger, verbose: int = 0, quiet: bool = False) -> None:
     """Set log level."""
@@ -98,7 +103,10 @@ def validate_scope(scope: str) -> bool:
     Returns:
         bool: True if scope is valid.
     """
-    resp = requests.get("https://frb.chimenet.ca/datatrail/query/dataset/scopes")
+    resp = requests.get(
+        "https://frb.chimenet.ca/datatrail/query/dataset/scopes",
+        timeout=REQUEST_TIMEOUT,
+    )
     scopes = decode_response(resp)
     return scope in scopes
 
@@ -116,7 +124,8 @@ def get_latest_released_version(
     Returns:
         str: Latest released version.
     """
-    req = requests.get(url_pattern.format(package=package))
+    # Short timeout: this runs at CLI startup and must not delay it.
+    req = requests.get(url_pattern.format(package=package), timeout=5)
     version = parse("0")
     if req.status_code == requests.codes.ok:
         j = json.loads(req.text.encode(req.encoding))  # type: ignore

{datatrail_cli-0.12.0 → datatrail_cli-0.13.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "datatrail-cli"
-version = "0.12.0"
+version = "0.13.0"
 description = "CHIME/FRB Datatrail CLI"
 authors = [
   { name = "CHIME FRB Project Office" },
@@ -57,6 +57,11 @@ ignore = "E203"
 [tool.isort]
 profile = "black"
 
+[tool.pytest.ini_options]
+markers = [
+  "cadc: tests that require CADC credentials",
+]
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"

datatrail_cli-0.13.0/release-please-config.json

@@ -0,0 +1,15 @@
+{
+  "packages": {
+    ".": {
+      "extra-files": [
+        {
+          "jsonpath": "$.package[?(@.name.value=='datatrail-cli')].version",
+          "path": "uv.lock",
+          "type": "toml"
+        }
+      ],
+      "package-name": "datatrail-cli"
+    }
+  },
+  "release-type": "python"
+}

{datatrail_cli-0.12.0 → datatrail_cli-0.13.0}/tests/test_cli.py

@@ -366,6 +366,7 @@ def test_cli_list_children(runner: CliRunner) -> None:
     assert "289007650" in result.output
 
 
+@pytest.mark.cadc
 def test_cli_ps(runner: CliRunner) -> None:
     """Test for CLI ps command.
 
@@ -376,6 +377,7 @@ def test_cli_ps(runner: CliRunner) -> None:
     assert result.exit_code == 0
 
 
+@pytest.mark.cadc
 def test_cli_pull_no(runner: CliRunner) -> None:
     """Test for CLI pull command.
 
@@ -397,6 +399,7 @@ def test_cli_pull_no(runner: CliRunner) -> None:
     assert expect in result.output
 
 
+@pytest.mark.cadc
 def test_cli_pull_yes(
     runner: CliRunner, directory: Path, list_specific_files: Path
 ) -> None:
@@ -427,6 +430,7 @@ def test_cli_pull_yes(
     ).exists()
 
 
+@pytest.mark.cadc
 def test_cli_clear_no(runner: CliRunner, directory: Path) -> None:
     """Test for CLI clear command.
 
@@ -450,6 +454,7 @@ def test_cli_clear_no(runner: CliRunner, directory: Path) -> None:
     assert "Roger roger, no files deleted" in result.output
 
 
+@pytest.mark.cadc
 def test_cli_clear_yes(runner: CliRunner, directory: Path) -> None:
     """Test for CLI clear command.
 
@@ -479,6 +484,7 @@ def test_cli_clear_yes(runner: CliRunner, directory: Path) -> None:
     ).exists()
 
 
+@pytest.mark.cadc
 def test_cli_pull_force(
     runner: CliRunner, directory: Path, list_specific_files: Path
 ) -> None:
@@ -509,6 +515,7 @@ def test_cli_pull_force(
     ).exists()
 
 
+@pytest.mark.cadc
 def test_cli_clear_force(runner: CliRunner, directory: Path) -> None:
     """Test for CLI clear command.
 
@@ -538,6 +545,7 @@ def test_cli_clear_force(runner: CliRunner, directory: Path) -> None:
     ).exists()
 
 
+@pytest.mark.cadc
 def test_cli_pull_force_2cores(runner: CliRunner, directory: Path) -> None:
     """Test for CLI pull command.
 
@@ -674,6 +682,7 @@ def test_cli_list_children_json(runner: CliRunner) -> None:
     assert "289007650" in output_data["datasets"]
 
 
+@pytest.mark.cadc
 def test_cli_ps_json(runner: CliRunner) -> None:
     """Test for CLI ps command with JSON output.
 
@@ -698,3 +707,22 @@ def test_cli_ps_json(runner: CliRunner) -> None:
     assert "policies" in output_data
     assert output_data["dataset"] == "289007650"
     assert output_data["scope"] == "chime.event.baseband.raw"
+
+
+def test_check_version_banner_on_stderr(monkeypatch, capsys) -> None:
+    """Test the update banner goes to stderr, keeping stdout parseable.
+
+    Args:
+        monkeypatch: Pytest monkeypatch fixture.
+        capsys: Pytest capture fixture.
+    """
+    from dtcli import cli as cli_module
+
+    monkeypatch.setattr(cli_module.utilities, "cli_is_latest_release", lambda: False)
+    monkeypatch.setattr(
+        cli_module.utilities, "get_latest_released_version", lambda: "99.0.0"
+    )
+    cli_module.check_version()
+    captured = capsys.readouterr()
+    assert "A new release of datatrail-cli is available" in captured.err
+    assert "A new release of datatrail-cli is available" not in captured.out

{datatrail_cli-0.12.0 → datatrail_cli-0.13.0}/tests/test_functions.py

@@ -5,6 +5,7 @@ from typing import Any, Dict, List, Optional
 
 import pytest
 
+from dtcli.src import functions
 from dtcli.src.functions import (
     find_unregistered_datasets,
     get_unregistered_dataset,
@@ -88,3 +89,26 @@ def test_find_unregistered_datasets() -> None:
 def test_find_unregistered_datasets_no_match() -> None:
     """Test find_unregistered_datasets with an event that is not unregistered."""
     assert find_unregistered_datasets("not-an-event") == []
+
+
+def test_list_scopes_unanswered(monkeypatch) -> None:
+    """Test a non-list scopes response becomes an error, not a payload."""
+
+    class _TextResponse:
+        status_code = 502
+        text = "Bad Gateway"
+
+    class _DictResponse:
+        status_code = 200
+
+        @staticmethod
+        def json() -> Dict[str, Any]:
+            return {"detail": "unexpected shape"}
+
+    monkeypatch.setattr(functions, "procure", lambda: {"server": "http://testserver"})
+    for response in (_TextResponse(), _DictResponse()):
+        monkeypatch.setattr(
+            functions.requests, "get", lambda url, timeout, _r=response: _r
+        )
+        results: Dict[str, Any] = functions.list()
+        assert results == {"error": "Datatrail did not answer the scopes query."}

{datatrail_cli-0.12.0 → datatrail_cli-0.13.0}/uv.lock

@@ -1140,7 +1140,7 @@ wheels = [
 
 [[package]]
 name = "datatrail-cli"
-version = "0.11.0"
+version = "0.13.0"
 source = { editable = "." }
 dependencies = [
     { name = "cadcdata" },