colrev.review_manager.ReviewManager¶

class ReviewManager(*, path_str=None, force_mode=False, verbose_mode=False, high_level_operation=False, navigate_to_home_dir=True, exact_call='', skip_upgrade=True)[source]¶

Bases: object

Class for managing individual CoLRev review project (repositories)

Methods

`check_repo`	Check the repository
`check_repository_setup`	Check the repository setup
`get_advisor`	Get an advisor object
`get_cached_session`	Get a cached session
`get_checker`	Get a checker object
`get_colrev_versions`	Get the CoLRev versions
`get_committer`	Get the committer name and email
`get_completeness_condition`	Get the completeness condition
`get_connecting_review_manager`	Get a (connecting) ReviewManager object for another CoLRev repository
`get_data_operation`	Get a data operation object
`get_dedupe_operation`	Get a dedupe operation object
`get_distribute_operation`	Get a distribute operation object
`get_environment_manager`	Get an environment manager
`get_grobid_service`	Get a grobid service object
`get_load_operation`	Get a load operation object
`get_loggers`	return loggers
`get_merge_operation`	Get a merge object
`get_package_manager`	Get a package manager object
`get_pdf_get_man_operation`	Get a pdf-get-man operation object
`get_pdf_get_operation`	Get a pdf-get operation object
`get_pdf_prep_man_operation`	Get a pdf-prep-man operation object
`get_pdf_prep_operation`	Get a pdfprep operation object
`get_pdf_qm`	Get the PDF quality model
`get_prep_man_operation`	Get a prep-man operation object
`get_prep_operation`	Get a prep operation object
`get_prescreen_operation`	Get a prescreen operation object
`get_pull_operation`	Get a pull operation object
`get_push_operation`	Get a push operation object
`get_qm`	Get the quality model
`get_remove_operation`	Get a a remove object
`get_repare`	Get a a repare object
`get_resources`	Get a resources object
`get_screen_operation`	Get a screen operation object
`get_search_operation`	Get a search operation object
`get_status_operation`	Get a status operation object
`get_status_stats`	Get a status stats object
`get_tei`	Get a tei object
`get_trace_operation`	Get a trace operation object
`get_upgrade`	Get an upgrade object
`get_validate_operation`	Get a validate operation object
`in_ci_environment`	Check whether CoLRev runs in a continuous-integration environment
`in_test_environment`	Check whether CoLRev runs in a test environment
`in_virtualenv`	Check whether CoLRev operates in a virtual environment
`load_settings`	Load the settings
`report`	Append commit-message report if not already available (Entrypoint for pre-commit hooks)
`reset_report_logger`	Reset the report logger
`save_settings`	Save the settings
`sharing`	Check whether sharing requirements are met (Entrypoint for pre-commit hooks)
`update_config`	Update review_manager's state
`update_status_yaml`	Update the STATUS_FILE

Attributes

`notified_next_operation`	ReviewManager was notified for the upcoming process and will provide access to the Dataset
`shell_mode`
`dataset`	The review dataset object
`path`	Path of the project repository
`force_mode`	Force mode variable (bool)
`verbose_mode`	Verbose mode variable (bool)
`high_level_operation`	A high-level operation was called (bool)

check_repo()[source]¶

Check the repository

Return type:: dict

check_repository_setup()[source]¶

Check the repository setup

Return type:: None

dataset: Dataset¶: The review dataset object

force_mode¶: Force mode variable (bool)

get_advisor()[source]¶

Get an advisor object

Return type:: Advisor

classmethod get_cached_session()[source]¶

Get a cached session

Return type:: CachedSession

get_checker()[source]¶

Get a checker object

Return type:: Checker

get_colrev_versions()[source]¶

Get the CoLRev versions

Return type:: list[str]

get_committer()[source]¶

Get the committer name and email

Return type:: Tuple[str, str]

get_completeness_condition()[source]¶

Get the completeness condition

Return type:: bool

get_connecting_review_manager(*, path_str=None, force_mode=False, verbose_mode=False)[source]¶

Get a (connecting) ReviewManager object for another CoLRev repository

Return type:: ReviewManager

get_data_operation(*, notify_state_transition_operation=True)[source]¶

Get a data operation object

Return type:: Data

get_dedupe_operation(*, notify_state_transition_operation=True)[source]¶

Get a dedupe operation object

Return type:: Dedupe

get_distribute_operation()[source]¶

Get a distribute operation object

Return type:: Distribute

classmethod get_environment_manager()[source]¶

Get an environment manager

Return type:: EnvironmentManager

classmethod get_grobid_service()[source]¶

Get a grobid service object

Return type:: GrobidService

get_load_operation(notify_state_transition_operation=True, hide_load_explanation=False)[source]¶

Get a load operation object

Return type:: Load

get_loggers()[source]¶

return loggers

Return type:: Tuple[Logger, Logger]

get_merge_operation()[source]¶

Get a merge object

Return type:: Merge

classmethod get_package_manager()[source]¶

Get a package manager object

Return type:: PackageManager

get_pdf_get_man_operation(*, notify_state_transition_operation=True)[source]¶

Get a pdf-get-man operation object

Return type:: PDFGetMan

get_pdf_get_operation(*, notify_state_transition_operation=True)[source]¶

Get a pdf-get operation object

Return type:: PDFGet

get_pdf_prep_man_operation(*, notify_state_transition_operation=True)[source]¶

Get a pdf-prep-man operation object

Return type:: PDFPrepMan

get_pdf_prep_operation(*, reprocess=False, notify_state_transition_operation=True)[source]¶

Get a pdfprep operation object

Return type:: PDFPrep

get_pdf_qm()[source]¶

Get the PDF quality model

Return type:: QualityModel

get_prep_man_operation(*, notify_state_transition_operation=True)[source]¶

Get a prep-man operation object

Return type:: PrepMan

get_prep_operation(*, notify_state_transition_operation=True, polish=False, cpu=4, debug=False)[source]¶

Get a prep operation object

Return type:: Prep

get_prescreen_operation(*, notify_state_transition_operation=True)[source]¶

Get a prescreen operation object

Return type:: Prescreen

get_pull_operation()[source]¶

Get a pull operation object

Return type:: Pull

get_push_operation(**kwargs)[source]¶

Get a push operation object

Return type:: Push

get_qm()[source]¶

Get the quality model

Return type:: QualityModel

get_remove_operation()[source]¶

Get a a remove object

Return type:: Remove

get_repare()[source]¶

Get a a repare object

Return type:: Repare

classmethod get_resources()[source]¶

Get a resources object

Return type:: Resources

get_screen_operation(*, notify_state_transition_operation=True)[source]¶

Get a screen operation object

Return type:: Screen

get_search_operation(*, notify_state_transition_operation=True)[source]¶

Get a search operation object

Return type:: Search

get_status_operation()[source]¶

Get a status operation object

Return type:: Status

get_status_stats(*, records=None)[source]¶

Get a status stats object

Return type:: StatusStats

get_tei(*, pdf_path=None, tei_path=None)[source]¶

Get a tei object

Return type:: TEIParser

get_trace_operation()[source]¶

Get a trace operation object

Return type:: Trace

get_upgrade()[source]¶

Get an upgrade object

Return type:: Upgrade

get_validate_operation()[source]¶

Get a validate operation object

Return type:: Validate

high_level_operation¶: A high-level operation was called (bool)

classmethod in_ci_environment()[source]¶

Check whether CoLRev runs in a continuous-integration environment

Return type:: bool

classmethod in_test_environment()[source]¶

Check whether CoLRev runs in a test environment

Return type:: bool

in_virtualenv()[source]¶

Check whether CoLRev operates in a virtual environment

Return type:: bool

load_settings()[source]¶

Load the settings

Return type:: Settings

notified_next_operation = None¶: ReviewManager was notified for the upcoming process and will provide access to the Dataset

path: Path¶: Path of the project repository

report(*, msg_file)[source]¶

Append commit-message report if not already available (Entrypoint for pre-commit hooks)

Return type:: None

reset_report_logger()[source]¶

Reset the report logger

Return type:: None

save_settings()[source]¶

Save the settings

Return type:: None

sharing()[source]¶

Check whether sharing requirements are met (Entrypoint for pre-commit hooks)

Return type:: dict

update_config(*, force_mode=False, verbose_mode=False, high_level_operation=False, exact_call='')[source]¶

Update review_manager’s state

Return type:: None

update_status_yaml(*, add_to_git=True, records=None)[source]¶

Update the STATUS_FILE

Return type:: None

verbose_mode¶: Verbose mode variable (bool)