colrev.ops.status.Status

class colrev.ops.status.Status(*, review_manager)[source]

Bases: Operation

Determine the status of the project.

Initialize the instance.

Methods

check_precondition

Check the operation precondition.

conclude

Conclude the operation (stop Docker containers).

decorate

Decorator for operations.

get_analytics

Get status analytics.

get_review_status_report

Get the review status report.

notify

Notify the review_manager about the next operation.

Attributes

type

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

get_analytics()[source]

Get status analytics.

Return type:

dict

get_review_status_report(*, records=None, colors=True)[source]

Get the review status report.

Return type:

str

notify(*, state_transition=True)

Notify the review_manager about the next operation.

Return type:

None