API Documentation

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"
      },
      "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"
      }
   }
}

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 IOTA_URL: Url = 'http://127.0.0.1:4041'

Constraints:

allowed_schemes = [‘http’, ‘https’]

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.types module

Module contents

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