Skip to content
XNATUM is a Python client that exposes XNAT objects and functions.
Python Batchfile Makefile HCL
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
docs
examples
xnatum
.gitignore
LICENSE
Makefile
README.md
make.bat
requirements.txt
setup.py

README.md

XNATUM

PyPI PyPI - Downloads PyPI - Python Version PyPI - Wheel PyPI - Implementation

XNATUM is a Python client that exposes in a simple way XNAT objects and functions. The aim is to make a simple Python package to everyone to use on top of Xnatpy. This reduces the need for the user to know the details of the REST API.

Getting started

To install just use the setup.py normally:

python setup.py install

or install directly via pip:

pip install xnatum

Useful development commands

To compile it locally:

python setup.py sdist bdist_wheel

To install a local version:

pip install ./dist/<archive> --upgrade

To upload it to Pypi:

python -m twine upload dist/*

Examples

You can find some code examples on how to use this package on the examples folder.

Documentation

The official documentation is avaiable at xnatum.readthedocs.org.

Workflow to contribute

To contribute to XNATUM, first create an Github account. Once this is done, fork the XNATUM repository to have you own repository, clone it using 'git clone'. Make your changes in your clone, push them to your forked repo, test them and when you are happy with them, send a pull request to the main repository.

Status

This package is currently been developed part of my MSc. thesis.

You can’t perform that action at this time.