Skip to main content

An XNAT client that exposes the XNAT REST interface as python objects. Part of the interface is automatically generated based on the servers data model as defined by the xnat schema.

Project description

A new XNAT client that exposes XNAT objects/functions as python objects/functions. The aim is to abstract as much of the REST API away as possible and make xnatpy feel like native Python code. This reduces the need for the user to know the details of the REST API. Low level functionality can still be accessed via the connection object which has get, head, put, post, delete methods for more directly calling the REST API.

Disclaimer

This is NOT pyxnat, but a new module which uses a different philosophy for the user interface. Pyxnat is located at: https://pythonhosted.org/pyxnat/

Getting started

To install just use the setup.py normally:

python setup.py install

or install directly using pip:

pip install xnat

To get started, create a connection and start querying:

>>> import xnat
>>> session = xnat.connect('https://central.xnat.org', user="", password="")
>>> session.projects['Sample_DICOM'].subjects

when using IPython most functionality can be figured out by looking at the available attributes/methods of the returned objects.

Credentials

To store credentials this module uses the .netrc file. This file contains login information and should be accessible ONLY by the user (if not, the module with throw an error to let you know the file is unsafe).

Documentation

The official documentation can be found at xnat.readthedocs.org This documentation is a stub, but shows the classes and methods available.

Status

Currently we have basic support for almost all data on XNAT servers. Also it is possible to import data via the import service (upload a zip file). There is also some support for working with the prearchive (reading, moving, deleting and archiving).

Any function not exposed by the object-oriented API of xnatpy, but exposed in the XNAT REST API can be called via the generic get/put/post methods in the session object.

There is at the moment still a lack of proper tests in the code base and the documentation is somewhat sparse, this is a known limitation and can hopefully be addressed in the future.

Project details


Download files

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

Source Distribution

xnat-0.7.2.tar.gz (116.6 kB view details)

Uploaded Source

Built Distribution

xnat-0.7.2-py2.py3-none-any.whl (113.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file xnat-0.7.2.tar.gz.

File metadata

  • Download URL: xnat-0.7.2.tar.gz
  • Upload date:
  • Size: 116.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for xnat-0.7.2.tar.gz
Algorithm Hash digest
SHA256 61b64997a96f86e86999e0bed0b8a466084812c4763987b43a6e8847165c0708
MD5 7cc0f2a5c1bae98bf081242ddd3370c2
BLAKE2b-256 9a041959d42ff1e0e3e83d8eba29b4a80701ffcaeca13ea03a3dfd8de76b3ec9

See more details on using hashes here.

File details

Details for the file xnat-0.7.2-py2.py3-none-any.whl.

File metadata

  • Download URL: xnat-0.7.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 113.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for xnat-0.7.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ad0d5006525be2834f50457d0dccb8e91356d31f3df3f13b56e6690443a8c62b
MD5 c6f1b7b1a4fb0aaa42dd3aed4bb79f0e
BLAKE2b-256 9624691d06314e5078c31662ceb1bf83d76c6a5fb11aeb17b5477cd26378b5de

See more details on using hashes here.

Supported by

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