pjkm.tui.app¶

pjkm TUI application — Textual-based wizard interface.

Classes¶

PjkmApp

Interactive project builder TUI.

Functions¶

run()

Entry point for the TUI.

Module Contents¶

class pjkm.tui.app.PjkmApp[source]¶

Bases: textual.app.App

Interactive project builder TUI.

TITLE = 'pjkm'[source]¶

A class variable to set the default title for the application.

To update the title while the app is running, you can set the [title][textual.app.App.title] attribute. See also [the Screen.TITLE attribute][textual.screen.Screen.TITLE].

SUB_TITLE = 'Project Builder'[source]¶

A class variable to set the default sub-title for the application.

To update the sub-title while the app is running, you can set the [sub_title][textual.app.App.sub_title] attribute. See also [the Screen.SUB_TITLE attribute][textual.screen.Screen.SUB_TITLE].

CSS_PATH = 'app.tcss'[source]¶: File paths to load CSS from.

BINDINGS = [('q', 'quit', 'Quit')][source]¶: The default key bindings.

on_mount()[source]¶

Return type:: None

set_archetype(name, archetype)[source]¶

Parameters:

name (str)
archetype (pjkm.core.models.project.Archetype)

Return type:

None

set_groups(groups)[source]¶

Parameters:: groups (list[str])
Return type:: None

start_build()[source]¶

Return type:: None

show_done(project_dir, success)[source]¶

Parameters:

project_dir (pathlib.Path)
success (bool)

Return type:

None

pjkm.tui.app.run()[source]¶

Entry point for the TUI.

Return type:: None