filip package

filip-Module. See readme or documentation for more information.

Subpackages

Submodules

filip.config module

Settings module to set url from .env.filip file. This can also seen as an example for other applications such as webapp that use the library. Using *.env belongs to best practices in containerized applications. Pydantic provides a convenient and clean way to manage environments.

pydantic settings filip.config.Settings[source]

Bases: BaseSettings

Settings class that reads environment variables from a local .env.filip file or environment variables. The .env.filip can be located anywhere in the FiLiP repository.

Show JSON schema
{
   "title": "Settings",
   "description": "Settings class that reads environment variables from a local `.env.filip`\nfile or environment variables. The `.env.filip` can be located anywhere\nin the FiLiP repository.",
   "type": "object",
   "properties": {
      "ORION_URL": {
         "default": "http://127.0.0.1:1026",
         "format": "uri",
         "minLength": 1,
         "title": "Orion Url",
         "type": "string"
      },
      "LD_ORION_URL": {
         "default": "http://127.0.0.1:1027",
         "format": "uri",
         "minLength": 1,
         "title": "Ld Orion Url",
         "type": "string"
      },
      "IOTA_URL": {
         "default": "http://127.0.0.1:4041",
         "format": "uri",
         "minLength": 1,
         "title": "Iota Url",
         "type": "string"
      },
      "QUANTUMLEAP_URL": {
         "default": "http://127.0.0.1:8668",
         "format": "uri",
         "minLength": 1,
         "title": "Quantumleap Url",
         "type": "string"
      },
      "MQTT_BROKER_URL": {
         "default": "mqtt://127.0.0.1:1883",
         "format": "uri",
         "minLength": 1,
         "title": "Mqtt Broker Url",
         "type": "string"
      },
      "LD_MQTT_BROKER_URL": {
         "default": "mqtt://127.0.0.1:1884",
         "format": "uri",
         "minLength": 1,
         "title": "Ld Mqtt Broker Url",
         "type": "string"
      },
      "FIWARE_SERVICE": {
         "default": "filip",
         "title": "Fiware Service",
         "type": "string"
      },
      "MINIMUM_ORION_VERSION": {
         "default": "3.6.0",
         "title": "Minimum Orion Version",
         "type": "string"
      }
   }
}

Config:

  • extra: str = ignore

  • env_file: *str = *

  • env_file_encoding: str = utf-8

Fields:
field CB_URL: Url = 'http://127.0.0.1:1026'
Constraints:

  • allowed_schemes = [‘http’, ‘https’]

field FIWARE_SERVICE: str = 'filip'
field IOTA_URL: Url = 'http://127.0.0.1:4041'
Constraints:

  • allowed_schemes = [‘http’, ‘https’]

field LD_CB_URL: Url = 'http://127.0.0.1:1027'
Constraints:

  • allowed_schemes = [‘http’, ‘https’]

field LD_MQTT_BROKER_URL: Url = 'mqtt://127.0.0.1:1884'
field MINIMUM_ORION_VERSION: str = '3.6.0'
field MQTT_BROKER_URL: Url = 'mqtt://127.0.0.1:1883'
field QL_URL: Url = 'http://127.0.0.1:8668'
Constraints:

  • allowed_schemes = [‘http’, ‘https’]

filip.custom_types module

Variable types and classes used for better validation