Usage

Data structure

iatikit uses a model that reflects IATI architecture.

digraph structure {
    bgcolor="#fcfcfc";

    registry [label="Registry"];
    publishers [label="PublisherSet", shape="box3d"];
    publisher [label="Publisher"];
    datasets [label="DatasetSet", shape="box3d"];
    dataset [label="Dataset"];
    activities [label="ActivitySet", shape="box3d"];
    organisations [label="OrganisationSet", shape="box3d"];

    registry -> publishers -> publisher -> datasets -> dataset;

    registry -> datasets [style="dashed"];
    registry -> activities [style="dashed"];
    registry -> organisations [style="dashed"];

    publisher -> activities [style="dashed"];
    publisher -> organisations [style="dashed"];

    dataset -> activities;
    dataset -> organisations;

}

The solid arrows show the main links between data types. The dotted arrows show additional links that iatikit provides.

The registry contains a list of publishers. Each publisher has zero or more datasets. Each dataset contains zero or more activities, or zero or more organisations.

Data operations

To construct a new Registry object, use:

import iatikit

registry = iatikit.data()

If no data can be found, a NoDataError is raised. If data is found to be “stale” (i.e. more than 7 days old) a warning is shown.