Settings

pydantic model tdemocracy.settings.Settings

Settings for tdemocracy. Per default, the values are being read from the environment as TDEMOCRACY_<key>, or the tdemocracy.env file.

Show JSON schema

{
   "title": "Settings",
   "description": "Settings for tdemocracy. Per default, the values are being read from the environment as `TDEMOCRACY_<key>`, or the `tdemocracy.env` file.",
   "type": "object",
   "properties": {
      "username": {
         "title": "Username",
         "type": "string"
      },
      "password": {
         "title": "Password",
         "type": "string"
      },
      "topic": {
         "default": "Ampel-TDEmocracy.nucelar-stream-dev",
         "title": "Topic",
         "type": "string"
      },
      "group_id": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Group Id"
      }
   },
   "additionalProperties": false,
   "required": [
      "username",
      "password"
   ]
}

Config:

• env_prefix: str = TDEMOCRACY_

• env_file: str = tdemocracy.env

field group_id: Any | None = None

Group ID when listening to the kafka stream. If None (default) a new value will be assigned with each call (good for testing). Set to a persistent <username>-<key> value to keep track of the stream position between calls (good for production).

field password: str [Required]

Password for the Hopskotch stream

field topic: str = 'Ampel-TDEmocracy.nucelar-stream-dev'

Hopskotch topic

field username: str [Required]

Username for the Hopskotch stream