Skip to main content

Basic library for interacting with the REST interface of XNAT.

Project description

The Boring XNAT Library (BXL)

PyPI version pipeline status coverage report

BXL is a library for interacting with the REST interface of XNAT (Extensible Neuroimaging Archive Toolkit), an open-source imaging informatics software platform.

Usage

Installation

BXL is available at PyPI, the Python Package Index.

With pip package management system:

 pip install bxl

Without pip:

 git clone https://gitlab.com/bbrc/xnat/bxl.git .
 cd ./bxl
 python setup.py install

Credentials handling

The xnat.Connection() class constructor expects a credentials argument to be passed when instantiated,

  • If is a tuple, it will proceed to a basic authentication procedure against the host XNAT instance.
  • If is a basestring, it will reuse it as a cookie for authentication against the host XNAT instance.
  • Otherwise (or if authentication procedure failed in the aforementioned cases), it will remain offline.

Examples

Connect to XNAT instance using an existing JSESSIONID token and get a list of user-visible XNAT projects

 import bxl.xnat as xlib

 c = xlib.Connection(hostname='http://myxnat.org',credentials='1A12346385E876546C99B4179E20986A')
 data = c.get_projects()

 projects = { item['ID'] : item['URI'] for item in data.values() }
 print(projects)

 c.close_jsession()            

Connect via 'with' statement to create a new Female subject 'dummy' in the 'test' project

 from bxl import xnat

 with xnat.Connection(hostname='http://myxnat.org',credentials=(usr,pwd)) as c :
     response = c._put_resource(URI = c.host + '/data/projects/test/subjects/dummy',
                                options = {'gender' : 'female'} )
     subject_uid = response.content
     print 'New subject %s created!' %subject_uid

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

bxl-0.3.4.post1-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

bxl-0.3.4.post1-py2-none-any.whl (17.1 kB view details)

Uploaded Python 2

File details

Details for the file bxl-0.3.4.post1-py3-none-any.whl.

File metadata

  • Download URL: bxl-0.3.4.post1-py3-none-any.whl
  • Upload date:
  • Size: 17.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for bxl-0.3.4.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 835e678acb7fe25d81f5d2f6fe97ea1c6d87da2f2891a181fd33d3221e5eaca7
MD5 d0553a6babf06af63f2fe04f406e0c82
BLAKE2b-256 f9e0f0f8212f7497b24fbb2b92f574d618e54606a7e1ae810e8188e8bd78d47c

See more details on using hashes here.

File details

Details for the file bxl-0.3.4.post1-py2-none-any.whl.

File metadata

  • Download URL: bxl-0.3.4.post1-py2-none-any.whl
  • Upload date:
  • Size: 17.1 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for bxl-0.3.4.post1-py2-none-any.whl
Algorithm Hash digest
SHA256 45c69277e0553dfb185e0b7eec4833a368525fd8292f44b4c59356e48fdff92c
MD5 55e76ce1c5638388c96ca7fa54658900
BLAKE2b-256 fecde508d4ba8701438feac712b2dc280cad6224f8a2a1c423cf8755daad5155

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page