colrev.utils

Utility helpers for CoLRev.

Functions

colrev.utils.get_cached_session	Get a cached session.
colrev.utils.get_project_home_dir	Get the root directory of the CoLRev project (i.e., the directory containing the .git directory).
colrev.utils.get_unique_filename	Get a unique filename for a (new) SearchSource.
colrev.utils.in_ci_environment	Return True if running in a CI environment (e.g., GitHub Actions).
colrev.utils.open_file	Open a file with the platform default opener or VS Code.
colrev.utils.p_print	Pretty-print obj using repository defaults.
colrev.utils.pformat	Return a pretty-formatted representation of obj.
colrev.utils.remove_stopwords	Remove stopwords from a string.
colrev.utils.resolved_command	Resolve a command on PATH and raise a clear error if it is unavailable.
colrev.utils.select_search_type	Select the SearchType (interactively if neccessary).