API Reference

Home ▸ API Reference

The Xigt Python package contains modules in the core API as well as some extra functionality that is included for convenience. All modules and sub-packages are under the xigt namespace.

Core Modules

• xigt.codecs - Reading And Writing Xigt Corpora
• [xigt.model](Data Structures) - Working with data structures
• xigt.ref - Working with references
• xigt.query - Functions for querying data

Extra Modules and Executables

• xigt.importers - Importing From Other Formats
• xigt.exporters - Exporting To Other Formats

Creating Alternative Implementations of the Xigt API

The Python implementation of the Xigt API described here is the official implementation, but other implementations are encouraged. For these alternative implementations, the following should be provided at a minimum:

• the XigtXML codec
• a model of the data structures (including methods for iterating over data containers, retrieving attributes, etc.)
• a method for resolving Alignment Expressions
• the algorithm for getting the value of an Item

It is recommended, but not necessary, to provide additional functions for navigating the data or interpreting references, like the following:

• ids()
• referents()
• referrers()
• ancestors()
• descendants()

Any other functionality is optional.