dgpost.main

Module containing the execution functions for dgpost.

dgpost.main.version_check(project='dgpost')

dgpost.main.run(path: str, patch: str | None = None) → tuple[dict, dict]

Main API execution function. Loads the recipe from the provided path, patches the file paths specified within the recipe, if necessary, and processes the following entries, in order:

• load,

• extract,

• pivot,

• transform,

• plot,

• save.

Note

When saving a table, its metadata entry will contain dgpost version information, as well as a copy of the recipe used to create the saved object.

Parameters:

path – Path to the job specification, passed to dgpost.utils.parse()

Returns:

A tuple of the loaded datagrams and exported & transformed tables.

Return type:

(datagrams, tables)

dgpost.main.run_with_arguments()

Main external execution function.

This is the function executed when dgpost is launched using the executable. It processes the --version command, sets the loglevel based on the number of -v/-q passed, and forwards the infile argument to run().