devboard ¤

Bases: Container, ModalMixin, NotifyMixin

A Devboard column.

Methods:

• action_apply –

  Apply an action to selected rows.

• apply –

  Apply action on given row.

• compose –

  Compose column widgets.

• list_projects –

  List projects for this column.

• modal –

  Push a modal.

• notify_error –

  Notify error.

• notify_info –

  Notify information.

• notify_success –

  Notify success.

• notify_warning –

  Notify warning.

• on_mount –

  Fill data table.

• populate_rows –

  Populate rows for this column.

• update –

  Update the column (recompute data).

Attributes:

• DEFAULT_CLASSES –

  Textual CSS classes.

• HEADERS (tuple[str, ...]) –

  The data table headers.

• THREADED (bool) –

  Whether actions of this column should run in the background.

• TITLE (str) –

  The title of the column.

• table (DataTable) –

  Data table.

DEFAULT_CLASSES = 'box'

HEADERS: tuple[str, ...] = ()

THREADED: bool = True

TITLE: str = ''

table: DataTable

action_apply(action: str = 'default') -> None

apply(action: str, row: Row) -> None

compose() -> ComposeResult

list_projects() -> Iterable[Project]

modal(text: str) -> None

notify_error(message: str, timeout: float = 3.0) -> None

notify_info(message: str, timeout: float = 3.0) -> None

notify_success(message: str, timeout: float = 3.0) -> None

notify_warning(message: str, timeout: float = 3.0) -> None

on_mount() -> None

populate_rows(project: Project) -> list[tuple[Any, ...]]

update() -> None

A class representing development projects.

It is instantiated with a path, and then provides many utility properties and methods.

Methods:

• checkout –

  Checkout branch, restore previous one when exiting.

• delete –

  Delete branch.

• fetch –

  Fetch.

• lock –

  Lock project.

• pull –

  Pull branch.

• push –

  Push branch.

• unlock –

  Unlock project.

• unpulled –

  Number of unpulled commits, per branch.

• unpushed –

  Number of unpushed commits, per branch.

• unreleased –

  List unreleased commits.

Attributes:

• DEFAULT_BRANCHES (tuple[str, ...]) –

  Name of common default branches. Mainly useful to compute unreleased commits.

• branch (Head) –

  Currently checked out branch.

• default_branch (str) –

  Default branch (or main branch), as checked out when cloning.

• is_dirty (bool) –

  Whether the project is in a "dirty" state (uncommitted modifications).

• latest_tag (TagReference) –

  Latest tag.

• name (str) –

  Name of the project.

• path (Path) –

  Path of the project on the file-system.

• repo (Repo) –

  GitPython's Repo object.

• status (Status) –

  Status of the project.

• status_line (str) –

  Status of the project, as a string.

DEFAULT_BRANCHES: tuple[str, ...] = ('main', 'master')

branch: Head

default_branch: str

is_dirty: bool

latest_tag: TagReference

name: str

path: Path

repo: Repo

status: Status

status_line: str

checkout(branch: str | None) -> Iterator[None]

delete(branch: str) -> None

fetch() -> None

lock() -> bool

pull(branch: str | None = None) -> None

push(branch: str | None = None) -> None

unlock() -> None

unpulled(remote: str = 'origin') -> dict[str, int]

unpushed(remote: str = 'origin') -> dict[str, int]

unreleased(branch: str | None = None) -> list[Commit]

Bases: SelectableRow

A Devboard row.

Methods:

• remove –

  Remove row from the table.

• select –

  Select this row.

• toggle_select –

  Toggle-select this row.

• unselect –

  Unselect this row.

Attributes:

• app (App) –

  Textual application.

• checkbox (Checkbox) –

  Row checkbox.

• data (list) –

  Row data (without checkbox).

• index (int) –

  Row index.

• next (SelectableRow) –

  Next row (down).

• previous (SelectableRow) –

  Previous row (up).

• project (Project) –

  Devboard project.

• selected (bool) –

  Whether this row is selected.

app: App

checkbox: Checkbox

data: list

index: int

next: SelectableRow

previous: SelectableRow

project: Project

selected: bool

remove() -> None

select() -> None

toggle_select() -> bool

unselect() -> None