colrev.package_manager.package_base_classes.DataPackageBaseClass

class colrev.package_manager.package_base_classes.DataPackageBaseClass(*, data_operation, settings, logger=None, verbose_mode=False)[source]

Bases: ABC

The base class for Data packages.

The following cli command calls the update_data method of a Data package:

colrev data -> calls package.update_data()

Methods

`get_advice`	Get advice on how to operate the data package endpoint.
`update_data`	Update the data by running the data operation.
`update_record_status_matrix`	Update the record status matrix.

Attributes

`ci_supported`
`settings_class`

abstract get_advice()[source]

Get advice on how to operate the data package endpoint.

Return type:: dict

abstract update_data(records, synthesized_record_status_matrix, silent_mode)[source]

Update the data by running the data operation.

Return type:: None

abstract update_record_status_matrix(synthesized_record_status_matrix, endpoint_identifier)[source]

Update the record status matrix.

Return type:: None