colrev.ops.upgrade.Upgrade

class Upgrade(*, review_manager)[source]

Bases: Operation

Upgrade a CoLRev project

Methods

check_precondition

Check the operation precondition

conclude

Conclude the operation (stop Docker containers)

decorate

Decorator for operations

load_records_dict

Load the records dictionary from a file and parse it using the bibtex parser.

main

Upgrade a CoLRev project (main entrypoint)

notify

Notify the review_manager about the next operation

save_records_dict

Save the records dictionary to a file and add it to the repository index.

Attributes

type

repo

check_precondition()

Check the operation precondition

Return type:

None

conclude()

Conclude the operation (stop Docker containers)

Return type:

None

classmethod decorate()

Decorator for operations

Return type:

Callable

load_records_dict()[source]

Load the records dictionary from a file and parse it using the bibtex parser.

Return type:

dict

Returns:

dict: The loaded records dictionary.

main()[source]

Upgrade a CoLRev project (main entrypoint)

Return type:

None

notify(*, state_transition=True)

Notify the review_manager about the next operation

Return type:

None

save_records_dict(records)[source]

Save the records dictionary to a file and add it to the repository index.

Return type:

None

Args:

records (dict): The records dictionary to save.