Command line tools

Use an alias token to connect an external tool to XNAT. Choose the client that suits your workflow.

Choose a tool

xnatutils

Install

Install xnatutils from PyPI:

pip3 install xnatutils

Authenticate with an alias token

Create a .netrc file in your home directory and add your XNAT server, alias and secret:

machine https://xnat.rcc.uq.edu.au
user <your-alias>
password <your-alias-secret>

xnatpy

Install

Install xnatpy from PyPI. The package name is xnat:

pip install xnat

Authenticate with an alias token

Pass your alias and secret when you create a session:

import xnat

with xnat.connect(
    'https://xnat.rcc.uq.edu.au',
    user='<your-alias>',
    password='<your-alias-secret>',
) as session:
    print(session.projects)

pyxnat

Install

Install pyxnat from PyPI:

pip install pyxnat

Authenticate with an alias token

Pass your alias and secret when you create an interface:

from pyxnat import Interface

xnat = Interface(
    server='https://xnat.rcc.uq.edu.au',
    user='<your-alias>',
    password='<your-alias-secret>',
)
print(xnat.select.projects().get())

Protect your credentials

Do not commit an alias or secret to source control. Restrict access to a .netrc file on Linux or macOS:

chmod 600 ~/.netrc

Revoke the alias token in XNAT when you no longer need it or if its secret may have been exposed.