Variables

Variables used for the configuration of the API

enum main.vars.Vars(value)

Variables used in the API.

Valid values are as follows:

LIPIDMAPS_DATABASE = <Vars.LIPIDMAPS_DATABASE: []>

Variable which will store the local database built from the SDF file of the LipidMaps Structure Database during the launch of the application. It will be a list a dictionnary where each dictionnary will contain 4 keys : LIPIDMAPS_ID, INCHI_KEY, STANDARDIAZED_NAME and SWISSLIPIDS_ID.

METADATA = <Vars.METADATA: {'SHA_1': None, 'SHORT_SHA_1': None, 'TIMESTAMP': None}>

Variable which will store the metadata about the version of the microservice that will be retrieve during the launch of the application.

Paths

enum main.vars.Paths(value)

Paths used in the API.

Valid values are as follows:

LIPIDMAPS_DATABASE = <Paths.LIPIDMAPS_DATABASE: 'http://mirror.dsi.uca.fr/metabocloud/structures.sdf'>

URL to the SDF file containing the LipidMaps Structure Database.

LIPID_CLASSES_SUPPORTED = <Paths.LIPID_CLASSES_SUPPORTED: './conf/lipid-list.csv'>

Relative path to the CSV file containing the lipid class that are supported by the Goslin tool. This file comes from the package pygoslin.

METADATA_JSON = <Paths.METADATA_JSON: './conf/goslin_about.json'>

Relative path to the template JSON file with the metadata of a microservice.

SWAGGER_CONF = <Paths.SWAGGER_CONF: './conf/goslin_doc.yaml'>

Relative path to the YAML configuration file of the Swagger documentation.

SWAGGER_DOC = <Paths.SWAGGER_DOC: 'https://metabocloud.mesocentre.uca.fr/goslin/goslin-swagger-link/api/doc'>

URL to the Swagger documentation.