User Reference

Session

Session(irods_env[, password, irods_home, cwd])

Session to connect and perform operations on the iRODS server.

IrodsPath

IrodsPath(session, *args)

A class analogous to the pathlib.Path for accessing iRods data.

Data Operations

download(irods_path, local_path[, ...])

Download a collection or data object to the local filesystem.

upload(local_path, irods_path[, overwrite, ...])

Upload a local directory or file to iRODS.

sync(source, target[, max_level, dry_run, ...])

Synchronize data between local and remote copies.

Metadata

MetaData(item[, blacklist])

iRODS metadata operations.

Searching for data

search_data(session[, path, path_pattern, ...])

Search for collections, data objects and metadata.

MetaSearch([key, value, units])

Named tuple to search for objects and collections.

Tickets

Tickets(session)

iRODS Ticket operations.