Skip to content

base

InstallResult

Bases: BaseModel

Represents the outcome of a single installation attempt.

Attributes:

Name Type Description
ok bool

Whether the installation completed successfully.
summary str

Short, user-facing message describing the outcome.
details str

Optional diagnostic information (stdout/stderr, error context).
Source code in src/awesome_os/tasks/managers/base.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
class InstallResult(BaseModel):
    """Represents the outcome of a single installation attempt.

    Attributes:
        ok: Whether the installation completed successfully.
        summary: Short, user-facing message describing the outcome.
        details: Optional diagnostic information (stdout/stderr, error context).
    """

    model_config = ConfigDict(frozen=True)

    ok: bool
    summary: str
    details: str = ""

Installer

Bases: Protocol

Protocol for a package installer backend.

Concrete managers wrap one package manager (apt, brew, winget, etc.) and should be written to be as idempotent as possible.

Note

This protocol is kept for backward compatibility. Prefer PackageManager for new code.

Source code in src/awesome_os/tasks/managers/base.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class Installer(Protocol):
    """Protocol for a package installer backend.

    Concrete managers wrap one package manager (apt, brew, winget, etc.) and
    should be written to be as idempotent as possible.

    Note:
        This protocol is kept for backward compatibility. Prefer
        `PackageManager` for new code.
    """

    name: str

    def is_installed(self, package: str) -> bool: ...

    def install(self, package: str) -> InstallResult: ...

PackageManager

Bases: Protocol

Protocol for a system package manager backend.

A package manager backend supports both
  • package-level operations (is_installed, install)
  • system maintenance operations (update, upgrade, cleanup)

This unifies what used to be split between an installer and a system manager so the UI can expose one coherent set of actions per manager.

Attributes:

Name Type Description
name str

A short identifier for the backend (e.g. "apt").
Source code in src/awesome_os/tasks/managers/base.py 
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
class PackageManager(Protocol):
    """Protocol for a system package manager backend.

    A package manager backend supports both:
        - package-level operations (`is_installed`, `install`)
        - system maintenance operations (`update`, `upgrade`, `cleanup`)

    This unifies what used to be split between an installer and a system manager
    so the UI can expose one coherent set of actions per manager.

    Attributes:
        name: A short identifier for the backend (e.g. `"apt"`).
    """

    name: str

    def is_installed(self, package: str) -> bool: ...

    def install(self, package: str) -> InstallResult: ...

    def update(self) -> TaskResult: ...

    def upgrade(self) -> TaskResult: ...

    def cleanup(self) -> TaskResult: ...