Skip to main content

Pydra2App - XNAT

tests codecov Python versions Latest Version docs

An extension for the Pydra2App framework that support for building XNAT "apps" (container service docker images) from Pydra tasks.

Quick Installation

This extension can be installed for Python 3 using pip:

$ pip3 install pydra2app-xnat

This will also install the core Pydra2App package and any required dependencies.

Reconcile XNAT pipelines

deploy-pipelines performs one reconciliation against a release catalogue and exits:

PIPELINE_CATALOGUE_URL=https://example.org/pipeline-release.json \
XNAT_HOST=https://xnat.example.org \
XNAT_USER=username \
XNAT_PASS=password \
pydra2app ext xnat deploy-pipelines

The catalogue may instead be passed as a local file or URL argument. The command reports each pipeline as installed, updated, unchanged, or failed, with how many of its commands were enabled, and exits nonzero if any pipeline fails. Existing commands are updated in place (keeping their site and project enablement), and commands absent from the catalogue are not removed. The XNAT user must be an administrator or a Container Service manager.

Selecting and enabling pipelines

A YAML config file passed to --config (or PIPELINE_RECONCILER_CONFIG) selects which catalogue pipelines are reconciled and whether their commands are enabled:

include:              # optional; leave out to take every pipeline
  - mri.human.neuro.*
exclude:              # optional; wins over include
  - mri.human.neuro.bidsapp.*
enablement: approval  # or "auto"; default is approval

Patterns are case-sensitive wildcards matched against the whole catalogue pipeline ID, where * also matches .. Excluded pipelines are left untouched even if already installed: their commands are not downloaded, updated or enabled. Invalid config fails before XNAT is contacted, and a pattern matching no pipeline logs a warning. Without a config, every pipeline is reconciled in approval mode.

  • approval: new commands are installed disabled until an administrator enables them.
  • auto: every selected command is enabled for the site on each run, including any an administrator has disabled. To block a pipeline, exclude it, then disable it in XNAT.

Either way, project owners still enable commands for their own projects.

License

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License

Creative Commons License: Attribution-NonCommercial-ShareAlike 4.0 International Creative Commons License: Attribution-NonCommercial-ShareAlike 4.0 International

Metadata

Release files for pydra2app-xnat 0.9.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pydra2app-xnat 0.9.3
File Size Uploaded Provenance Actions
pydra2app_xnat-0.9.3.tar.gz 37.8 kB Without provenance Details for pydra2app_xnat-0.9.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pydra2app-xnat 0.9.3
File Interpreter ABI Platform Actions
pydra2app_xnat-0.9.3-py3-none-any.whl Python 3 none any Details for pydra2app_xnat-0.9.3-py3-none-any.whl

Total release size: 86.7 kB

Release files / pydra2app_xnat-0.9.3.tar.gz

Download URL pydra2app_xnat-0.9.3.tar.gz
Size 37.8 kB
Tags Source
SHA-256 checksum
How to use checksums
51e76dc04b191f927f664c3d3b9b3eac9b15555b297bad3db0fa618c990469fc
BLAKE2b-256 checksum
How to use checksums
e1f0e139becc352172ee67432018d767c25b34d08117210763f424304fab7c9e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / pydra2app_xnat-0.9.3-py3-none-any.whl

Download URL pydra2app_xnat-0.9.3-py3-none-any.whl
Size 48.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7c13b133266ab74cbc525250cfddf8593a422c331da1fed0aedfe8d4e7b83e72
BLAKE2b-256 checksum
How to use checksums
3018df21a2218ea520b342b695f7ee02a035d70d9372ccbc415c89450410957c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for pydra2app-xnat 0.9.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page