colrev.ops.search_api_feed.SearchAPIFeed

class SearchAPIFeed(*, review_manager, source_identifier, search_source, update_only, prep_mode=False)[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

Returns the date of the last update (if available) in YYYY-MM-DD format

get_prev_feed_record

Get the previous record dict version

save

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

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]

Returns the date of the last update (if available) in YYYY-MM-DD format

Return type:

str

get_prev_feed_record(record)[source]

Get the previous record dict version

Return type:

Record

save(*, skip_print=False)[source]

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

Return type:

None