Skip to content

woodglue.config

YAML-backed server configuration.

YAML-backed server configuration.

The config file lives at {data_dir}/woodglue.yaml and is required to run the server. It declares storage, namespaces, documentation, UI, and engine settings.

WoodglueStorageConfig

Bases: StorageConfig

Extends lythonic StorageConfig with woodglue-specific storage.

Source code in src/woodglue/config.py 
21
22
23
24
class WoodglueStorageConfig(StorageConfig):
    """Extends lythonic StorageConfig with woodglue-specific storage."""

    auth_db: Path | None = None

DocsConfig

Bases: BaseModel

Documentation generation settings.

Source code in src/woodglue/config.py 
27
28
29
30
31
class DocsConfig(BaseModel):
    """Documentation generation settings."""

    enabled: bool = True
    openapi: bool = True

UiConfig

Bases: BaseModel

JavaScript documentation UI settings.

Source code in src/woodglue/config.py 
34
35
36
37
class UiConfig(BaseModel):
    """JavaScript documentation UI settings."""

    enabled: bool = True

NamespaceEntry

Bases: BaseModel

Per-namespace configuration. Exactly one of gref, file, or entries must be set to specify how the namespace is instantiated.

Source code in src/woodglue/config.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
class NamespaceEntry(BaseModel):
    """
    Per-namespace configuration. Exactly one of `gref`, `file`, or `entries`
    must be set to specify how the namespace is instantiated.
    """

    gref: str | None = None
    file: str | None = None
    entries: list[NsNodeConfig] | None = None
    expose_api: bool = True
    run_engine: bool = False

    @model_validator(mode="after")
    def _exactly_one_source(self) -> NamespaceEntry:
        sources = [self.gref is not None, self.file is not None, self.entries is not None]
        if sum(sources) != 1:
            raise ValueError("Exactly one of gref, file, or entries must be set")
        return self

AuthConfig

Bases: BaseModel

Bearer token authentication settings.

Source code in src/woodglue/config.py 
60
61
62
63
class AuthConfig(BaseModel):
    """Bearer token authentication settings."""

    enabled: bool = True

WoodglueConfig

Bases: BaseModel

Root configuration loaded from woodglue.yaml.

namespaces maps a prefix string to a NamespaceEntry dict with exactly one of gref, file, or entries, plus optional expose_api and run_engine flags.

Source code in src/woodglue/config.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
class WoodglueConfig(BaseModel):
    """
    Root configuration loaded from `woodglue.yaml`.

    `namespaces` maps a prefix string to a `NamespaceEntry` dict with exactly
    one of `gref`, `file`, or `entries`, plus optional `expose_api` and
    `run_engine` flags.
    """

    host: str = "127.0.0.1"
    port: int = 5321
    storage: WoodglueStorageConfig = WoodglueStorageConfig()
    namespaces: dict[str, NamespaceEntry]
    docs: DocsConfig = DocsConfig()
    ui: UiConfig = UiConfig()
    auth: AuthConfig = AuthConfig()

load_config(data_dir)

Load WoodglueConfig from {data_dir}/woodglue.yaml.

Raises FileNotFoundError if the file does not exist.

Source code in src/woodglue/config.py 
84
85
86
87
88
89
90
91
92
93
def load_config(data_dir: Path) -> WoodglueConfig:
    """
    Load `WoodglueConfig` from `{data_dir}/woodglue.yaml`.

    Raises `FileNotFoundError` if the file does not exist.
    """
    config_path = data_dir / CONFIG_FILENAME
    if not config_path.exists():
        raise FileNotFoundError(f"Config file not found: {config_path}")
    return parse_yaml_file_as(WoodglueConfig, config_path)