Skip to content

Config

Configuration module.

Config

Bases: BaseSettings

Configuration class.

Attributes:

Name Type Description
database_url Optional[str]

Database URL. If not provided, a SQLite database will be created in the devpipe working directory. Any SQLAlchemy-compatible URL is accepted, provided that the required database driver is installed.
database_prefix str

Database tables prefix.
working_dir Path

devpipe working directory.

Info

Configuration is loaded from environment variables prefixed with DEVPIPE_. For example, DEVPIPE_DATABASE_URL=postgresql://user:password@localhost:5432/db. sets the database_url attribute so that devpipe uses a PostgreSQL database.

Source code in devpipe/config.py 
11
12
13
14
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
class Config(BaseSettings):
    """Configuration class.

    Attributes:
        database_url (Optional[str]): Database URL. If not provided, a
            SQLite database will be created in the devpipe working
            directory. Any SQLAlchemy-compatible URL is accepted, provided
            that the required database driver is installed.
        database_prefix (str): Database tables prefix.
        working_dir (Path): devpipe working directory.

    !!! info
        Configuration is loaded from environment variables prefixed with
        `DEVPIPE_`. For example,
        `DEVPIPE_DATABASE_URL=postgresql://user:password@localhost:5432/db`.
        sets the `database_url` attribute so that devpipe uses a PostgreSQL
        database.
    """

    database_url: Optional[str] = Field(default=None)
    database_prefix: str = Field(default="devpipe")
    working_dir: Path = Field(
        default_factory=lambda: Path(".devpipe"),
    )

    model_config = SettingsConfigDict(
        env_prefix="DEVPIPE_",
    )

    @model_validator(mode="after")
    def _set_default_database_url(self) -> Self:
        if self.database_url is None:
            file = self.working_dir / ".devpipe.sqlite"
            self.database_url = f"sqlite:///{file.absolute()}"
        return self