colrev.ops.search_api_feed.SearchAPIFeed¶

class colrev.ops.search_api_feed.SearchAPIFeed(*, source_identifier, search_source, update_only, logger, prep_mode=False, verbose_mode=False, records=None)[source]¶

Bases: object

A feed managing results from API searches

Methods

`add_record_to_feed`	Add a record to the feed and set its colrev_origin
`add_update_record`	Add or update a record in the api_search_feed and records
`get_last_updated`	Get the last updated timestamp.
`get_prev_feed_record`	Get the previous record dict version
`get_records`	Get the prepared (primary) records
`save`	Save the feed file and records, printing post-run search infos.

Attributes

source_identifier

Get the source identifier

add_record_to_feed(record, prev_feed_record)[source]¶

Add a record to the feed and set its colrev_origin

Return type:: bool

add_update_record(retrieved_record)[source]¶

Add or update a record in the api_search_feed and records

Return type:: bool

get_last_updated()[source]¶

Get the last updated timestamp.

Return type:: str

get_prev_feed_record(record)[source]¶

Get the previous record dict version

Return type:: Record

get_records()[source]¶

Get the prepared (primary) records

Return type:: dict

save(*, skip_print=False)[source]¶

Save the feed file and records, printing post-run search infos.

Return type:: None

property source_identifier: str¶: Get the source identifier