colrev.ops.pdf_prep.PDFPrep

class PDFPrep(*, review_manager, reprocess=False, notify_state_transition_operation=True)[source]

Bases: Operation

Prepare PDFs

Methods

check_precondition

Check the operation precondition

conclude

Conclude the operation (stop Docker containers)

decorate

Decorator for operations

generate_tei

Generate TEI documents for included records

main

rtype:

Any

notify

Notify the review_manager about the next operation

prepare_pdf

Prepare a PDF (based on package_endpoints in the settings)

setup_custom_script

Setup a custom pdf-prep script

update_colrev_pdf_ids

Update the colrev-pdf-ids

Attributes

type

to_prepare

pdf_prepared

not_prepared

pdf_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

generate_tei()[source]

Generate TEI documents for included records

Return type:

None

notify(*, state_transition=True)

Notify the review_manager about the next operation

Return type:

None

prepare_pdf(item)[source]

Prepare a PDF (based on package_endpoints in the settings)

Return type:

dict

setup_custom_script()[source]

Setup a custom pdf-prep script

Return type:

None

update_colrev_pdf_ids()[source]

Update the colrev-pdf-ids

Return type:

None