Skip to content

settings

VolurApiSettings

Bases: BaseSettings

Settings for Völur API client.

This class is used to obtain required configurations for the client to work properly.

This class requires two environment variables to be set:

  • VOLUR_API_ADDRESS: Address of the Völur API server,
  • VOLUR_API_TOKEN: Token for authenticating to the Völur API server.

Please contact Völur to obtain the endpoint address and the token.

Examples:

example.py
1
settings = VolurApiSettings()
Source code in src/volur/api/v1alpha1/settings.py 
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class VolurApiSettings(BaseSettings):
    """Settings for Völur API client.

    This class is used to obtain required configurations for the client to work
    properly.

    This class requires two environment variables to be set:

    - `VOLUR_API_ADDRESS`: Address of the Völur API server,
    - `VOLUR_API_TOKEN`: Token for authenticating to the Völur API server.

    Please contact Völur to obtain the endpoint address and the token.

    Examples:
        ```python title="example.py" linenums="1"
        settings = VolurApiSettings()
        ```
    """

    model_config = SettingsConfigDict(
        env_file=".env",
        env_file_encoding="utf-8",
        env_prefix="VOLUR_API_",
    )
    address: str
    token: SecretStr
    debug: bool = Field(
        False,
        description="Enable debug mode",
    )