VSCiRODSSession¶

class vsc_irods.session.VSCiRODSSession(txt='-', **kwargs)[source]¶

An extension to the iRODSSession class from python-irodsclient

The main goal is to make it easy to get/put/move/delete/… sets of data objects and collections within a Python script or a shell session.

Example:

>>> with VSCiRODSSession() as session:
>>>    session.bulk.get('~/my_irods_collection/*.txt', local_path='.')

Note

The initial iRODS current working directory is set to the user’s iRODS “home” directory (see vsc_irods.manager.path_manager.PathManager.get_irods_home()) This can be changed with vsc_irods.manager.path_manager.PathManager.ichdir().

Arguments:

txt: None or str (default: ‘-‘): Where output should be printed Use ‘-‘ for stdout, None for /dev/null, any other string for a text file, or a file handle