pyxnat.Interface

class pyxnat.Interface(server=None, user=None, password=None, cachedir='/tmp', config=None, anonymous=False)

Main entry point to access a XNAT server.

>>> central = Interface(server='http://central.xnat.org:8080',
                        user='login',
                        password='pwd',
                        cachedir='/tmp'
                        )

Or with config file:

>>> central = Interface(config='/home/me/.xnat.cfg')

Or for interactive use:

>>> central = Interface('http://central.xnat.org')

Note

The interactive mode is activated whenever an argument within server, user or password is missing. In interactive mode pyxnat tries to check the validity of the connection parameters.

Or anonymously (unauthenticated):

>>> central = Interface('http://central.xnat.org', anonymous=True)
Attributes :

_mode: online | offline :

Online or offline mode

_memtimeout: float :

Lifespan of in-memory cache

Previous topic

pyxnat.Users

Next topic

pyxnat.Select

This Page