Skip to content

Configuration

boostylib.config.BoostySettings

Bases: BaseSettings

Boosty client configuration.

All fields can be overridden via: - Environment variables with BOOSTY_ prefix (e.g. BOOSTY_TIMEOUT=10) - TOML config file boosty.toml (requires tomli / Python 3.11+) - Constructor arguments

Source code in src/boostylib/config.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
class BoostySettings(BaseSettings):
    """Boosty client configuration.

    All fields can be overridden via:
    - Environment variables with ``BOOSTY_`` prefix (e.g. ``BOOSTY_TIMEOUT=10``)
    - TOML config file ``boosty.toml`` (requires ``tomli`` / Python 3.11+)
    - Constructor arguments
    """

    model_config = SettingsConfigDict(
        env_prefix="BOOSTY_",
        extra="ignore",
    )

    @classmethod
    def settings_customise_sources(
        cls,
        settings_cls: type[BaseSettings],
        init_settings: PydanticBaseSettingsSource,
        env_settings: PydanticBaseSettingsSource,
        dotenv_settings: PydanticBaseSettingsSource,
        file_secret_settings: PydanticBaseSettingsSource,
    ) -> tuple[PydanticBaseSettingsSource, ...]:
        sources: list[PydanticBaseSettingsSource] = [
            init_settings,
            env_settings,
        ]
        if _HAS_TOML:
            sources.append(TomlConfigSettingsSource(settings_cls, toml_file="boosty.toml"))
        sources.append(file_secret_settings)
        return tuple(sources)

    # API
    base_url: str = "https://api.boosty.to/v1"
    timeout: float = 30.0

    # Retry
    max_retries: int = 3
    retry_backoff_factor: float = 0.5

    # Rate limiting
    rate_limit_requests: int = 60
    rate_limit_period: float = 60.0

    # Polling
    poll_interval: float = 30.0

    # Auth
    token_refresh_margin: int = 300  # seconds before expiry to trigger refresh

    # Cache
    cache_enabled: bool = True
    cache_ttl_blog: int = 300
    cache_ttl_levels: int = 600
    cache_ttl_user: int = 120
    cache_ttl_default: int = 60

    # Debug
    debug: bool = False