colrev.ops.prep.Prep

class colrev.ops.prep.Prep(*, review_manager, notify_state_transition_operation, polish, cpu)

Bases: Operation

Prepare records (metadata).

Initialize the instance.

Methods

check_precondition	Check the operation precondition.
conclude	Conclude the operation (stop Docker containers).
decorate	Decorator for operations.
main	rtype: Any
notify	Notify the review_manager about the next operation.
prepare	Prepare a record (based on package_endpoints in the settings).
set_ids	Set IDs (regenerate).
setup_custom_script	Setup a custom prep script.

Attributes

max_retries_on_error
pad
polish
timeout
type
first_round
last_round
prep_package_endpoints

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

notify(*, state_transition=True)

Notify the review_manager about the next operation.

Return type:

None

prepare(item)

Prepare a record (based on package_endpoints in the settings).

Return type:

dict

set_ids()

Set IDs (regenerate). In force-mode, all IDs are regenerated and PDFs are renamed.

Return type:

None

setup_custom_script()

Setup a custom prep script.

Return type:

None