default_board ¤

Bases: Project

Customized project class.

The original Project is sub-classed for demonstration purpose. Feel free to add any attribute, property or method to it, to serve your own needs. You can also override its existing property and methods if needed. In the default class below, we add the list_projects class method that will be passed to Column instances, allowing them to iterate on your projects.

Methods:

• checkout –

  Checkout branch, restore previous one when exiting.

• delete –

  Delete branch.

• fetch –

  Fetch.

• list_projects –

  List all Git projects in a base directory.

• 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

list_projects() -> Iterator[Project]

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: Column

A column showing projects with uncommitted changes.

Methods:

• action_apply –

  Apply an action to selected rows.

• apply –

  Process actions.

• 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 –

  Scan a project, feeding rows to the table.

• update –

  Update the column (recompute data).

Attributes:

• DEFAULT_CLASSES –

  Textual CSS classes.

• table (DataTable) –

  Data table.

DEFAULT_CLASSES = 'box'

table: DataTable

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

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

compose() -> ComposeResult

list_projects() -> Iterator[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

Bases: Column

A column showing branches with commits that should be pulled.

Methods:

• action_apply –

  Apply an action to selected rows.

• apply –

  Process actions.

• 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 –

  Scan a project, feeding rows to the table.

• update –

  Update the column (recompute data).

Attributes:

• DEFAULT_CLASSES –

  Textual CSS classes.

• THREADED (bool) –

  Whether actions of this column should run in the background.

• table (DataTable) –

  Data table.

DEFAULT_CLASSES = 'box'

THREADED: bool = True

table: DataTable

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

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

compose() -> ComposeResult

list_projects() -> Iterator[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

Bases: Column

A column showing branches with commits that should be pushed.

Methods:

• action_apply –

  Apply an action to selected rows.

• apply –

  Process actions.

• 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 –

  Scan a project, feeding rows to the table.

• update –

  Update the column (recompute data).

Attributes:

• DEFAULT_CLASSES –

  Textual CSS classes.

• THREADED (bool) –

  Whether actions of this column should run in the background.

• table (DataTable) –

  Data table.

DEFAULT_CLASSES = 'box'

THREADED: bool = True

table: DataTable

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

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

compose() -> ComposeResult

list_projects() -> Iterator[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

Bases: Column

A column showing projects with commits that should be released.

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 –

  Scan a project, feeding rows to the table.

• update –

  Update the column (recompute data).

Attributes:

• DEFAULT_CLASSES –

  Textual CSS classes.

• THREADED (bool) –

  Whether actions of this column should run in the background.

• table (DataTable) –

  Data table.

DEFAULT_CLASSES = 'box'

THREADED: bool = True

table: DataTable

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

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

compose() -> ComposeResult

list_projects() -> Iterator[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