BaseCore

class q2_sdk.models.cores.base_core.BaseCore(logger, core_user, hq_credentials=None, db_config_dict=None)

If REQUIRED_CONFIGURATIONS is set, ensures the entries are set in the core’s settings file or the web server will not start.

REQUIRED_CONFIGURATIONS is a dictionary of key value pairs where the key is the required name and the value is the default value when q2 generate_config is called.

OPTIONAL_CONFIGURATIONS is identical to REQUIRED_CONFIGURATIONS, but will not prevent the web server from starting if missing.

All cores will inherit from this common base class. This contains a self.configured_user property, which is an instance of q2_sdk.models.cores.models.core_user.CoreUser.

async build_demographic_info()

Returns a DemographicInfoMapper ready to execute

Return type:

BaseDemographicInfoMapper

async build_update_demographic_info(demographic_info)

Returns a UpdateDemographicInfoMapper ready to execute

Return type:

BaseUpdateDemographicInfoMapper

async build_get_cards()

Returns a CardListMapper ready to execute

Return type:

BaseCardListMapper

update_configured_user(user)

If it is necessary to call the core for a user OTHER than the current online_user, first call this method with a new q2_sdk.hq.models.OnlineUser instance