flip_api.utils.constants

Attributes

`SERVICE_UNAVAILABLE_MESSAGE`
`ACCESS_REQUEST_TEMPLATE_NAME`
`IMAGING_CREDENTIALS_TEMPLATE_NAME`
`IMAGING_PROJECT_ACCESS_TEMPLATE_NAME`
`JOB_TYPES_REQUIRED_FILES_S3_NAME`
`BASE_URL`
`ADMIN_EMAIL_1`
`ADMIN_EMAIL_2`
`ADMIN_EMAIL_3`
`RESEARCHER_EMAIL`
`VIEWER_EMAIL`

`job_types_required_files_name`(→ str)	Local filename for the per-backend job-types/required-files manifest.
`job_types_required_files_s3_key`(→ str)	S3 key (relative to `FL_APP_BASE_BUCKET`) of the per-backend required-files manifest.

flip_api.utils.constants.SERVICE_UNAVAILABLE_MESSAGE = 'The server is unable to process any requests at the moment, please try again later.'

flip_api.utils.constants.ACCESS_REQUEST_TEMPLATE_NAME = 'flip-access-request'

flip_api.utils.constants.IMAGING_CREDENTIALS_TEMPLATE_NAME = 'flip-xnat-credentials'

flip_api.utils.constants.IMAGING_PROJECT_ACCESS_TEMPLATE_NAME = 'flip-xnat-added-to-project'

flip_api.utils.constants.job_types_required_files_name(fl_backend: flip_api.domain.schemas.types.FLBackend) → str

Local filename for the per-backend job-types/required-files manifest.

Parameters:: fl_backend (FLBackend) – The FL backend the manifest belongs to (nvflare or flower).
Returns:: The manifest filename, e.g. job_types_and_required_files.nvflare.json.
Return type:: str

flip_api.utils.constants.JOB_TYPES_REQUIRED_FILES_S3_NAME = 'required_files.json'

flip_api.utils.constants.job_types_required_files_s3_key(fl_backend: flip_api.domain.schemas.types.FLBackend) → str

S3 key (relative to FL_APP_BASE_BUCKET) of the per-backend required-files manifest.

Parameters:: fl_backend (FLBackend) – The FL backend whose manifest to locate (nvflare or flower).
Returns:: The per-backend key, e.g. nvflare/required_files.json.
Return type:: str