Skip to content

Settings

Settings

Bases: BaseSettings

Assured API configuration.

Reads from environment variables or a .env file located in the current working directory (or any parent).

Required variables

ASSURED_BASE_URL : str Base URL of the Assured backend (e.g. https://demo-backend.withassured.com). ASSURED_API_KEY : str Secret API key sent via the x-api-key header. ASSURED_USER : str Email used for JWT-based undocumented endpoints. ASSURED_PASS : str Password used for JWT-based undocumented endpoints.

Source code in src/assured/settings.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
class Settings(BaseSettings):
    """Assured API configuration.

    Reads from environment variables or a ``.env`` file located in the
    current working directory (or any parent).

    Required variables
    ------------------
    ASSURED_BASE_URL : str
        Base URL of the Assured backend (e.g. ``https://demo-backend.withassured.com``).
    ASSURED_API_KEY : str
        Secret API key sent via the ``x-api-key`` header.
    ASSURED_USER : str
        Email used for JWT-based undocumented endpoints.
    ASSURED_PASS : str
        Password used for JWT-based undocumented endpoints.
    """

    model_config = SettingsConfigDict(
        env_prefix="ASSURED_",
        env_file=".env",
        env_file_encoding="utf-8",
        extra="ignore",
    )

    base_url: str = "https://demo-backend.withassured.com"
    api_key: str = ""
    user: str = ""
    password: str = Field(default="", validation_alias="assured_pass")