datopy.modeling.BaseProcessor#

class BaseProcessor(
model: BaseModel,
query: NamedTuple,
)[source]#

Bases: object

The fundamental data processing structure.

Parameters:
  • model (BaseModel) – _description_.

  • query (NamedTuple) – _description_.

Methods

process()

Prepare (extract/clean) the retrieved data.

retrieve()

Extract data for the query from the API of the supplied model.

to_df()

Load the data into a dataframe for further processing or analysis.

retrieve()[source]#

Extract data for the query from the API of the supplied model.

Raises:

NotImplementedError – _description_.

process()[source]#

Prepare (extract/clean) the retrieved data.

Raises:

NotImplementedError – _description_.

to_df() DataFrame[source]#

Load the data into a dataframe for further processing or analysis.

Returns:

The processed entry as a data frame.

Return type:

pd.DataFrame