Module reference

This section provides a reference for the python-icat modules.

Modules defining the python-icat core API

These modules define the core of python-icat, e.g. the classes or functions that common python-icat programs interact with.

• icat.client — Provide the Client class
• icat.config — Manage configuration
• icat.entities — Provide classes corresponding to the ICAT schema
• icat.entity — Provide the Entity class
• icat.exception — Exception handling
• icat.ids — Provide the IDSClient class
• icat.query — Provide the Query class

Special purpose modules

These modules will generally be used in particular cases only.

• icat.eval — Evaluate expression in the context of an ICAT session
• icat.dumpfile — Backend for icatdump and icatingest
• icat.ingest — Ingest metadata into ICAT

Internal modules

These modules are used internally by python-icat, but most users will not need to care about them.

• icat.authinfo — Provide the AuthenticatorInfo class
• icat.dumpfile_xml — XML data file backend
• icat.dumpfile_yaml — YAML data file backend
• icat.dump_queries — Queries needed to dump the ICAT content
• icat.helper — A collection of internal helper routines
• icat.listproxy — Provide the ListProxy class
• icat.sslcontext — Helper functions and classes related to SSL contexts