API reference

The package interfaces are documented here.

colrev

Top-level package for CoLRev.

Interfaces

colrev.ui_cli	Command-line interface.
colrev.hooks	Pre-commit-hooks interface, automatically set up for every CoLRev project:

High-level (project)

colrev.review_manager	Review Manager.
colrev.settings	Settings of the project.
colrev.ops	Operations.
colrev.process	Process model (states, transitions, corresponding operations).
colrev.dataset	Dataset class providing functionality for data/records.bib and git repository.

High-level (environment)

colrev.env	Environment.
colrev.package_manager	Package manager.

Low-level

colrev.constants	Constants, including filepaths, fields, entrytypes, colrev_status, etc.
colrev.logger	Logger.
colrev.exceptions	Exceptions.
colrev.paths	CoLRev standard paths.
colrev.loader	Loaders for different data formats, including BibTex, RIS, CSV/Excel files.
colrev.writer	Writers for different data formats, including BibTex, RIS, CSV/Excel files.
colrev.record	Records containing title, author, year, etc.