colrev.settings.Settings

class colrev.settings.Settings(**data)

Bases: BaseModel

CoLRev project settings

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

get_packages	Get the list of all package names
is_curated_masterdata_repo	Check whether the masterdata is curated in this repository
is_curated_repo	Check whether data is curated in this repository
validate_sources	Validate the sources

Attributes

project
sources
search
prep
dedupe
prescreen
pdf_get
pdf_prep
screen
data

get_packages()

Get the list of all package names

Return type:

List[str]

is_curated_masterdata_repo()

Check whether the masterdata is curated in this repository

Return type:

bool

is_curated_repo()

Check whether data is curated in this repository

Return type:

bool

classmethod validate_sources(value)

Validate the sources

Return type:

List[ExtendedSearchFile]