Merge pull request #2065 from freakboy3742/textual

Add a Textual backend.
beeware · Aug 19, 2023 · 4dd84fa · 4dd84fa
2 parents 53bb064 + edcab76
commit 4dd84fa
Show file tree

Hide file tree

Showing 72 changed files with 833 additions and 129 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -54,6 +54,7 @@ jobs:
         - "gtk"
         - "iOS"
         - "toga"
+        - "textual"
         - "web"
         - "winforms"
 

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -20,6 +20,7 @@ jobs:
         - "toga_demo"
         - "toga_dummy"
         - "toga_gtk"
+        - "toga_textual"
         - "toga_iOS"
         - "toga_web"
         - "toga_winforms"

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -51,6 +51,7 @@ jobs:
         - "toga_dummy"
         - "toga_gtk"
         - "toga_iOS"
+        - "toga_textual"
         - "toga_web"
         - "toga_winforms"
     steps:

diff --git a/changes/1867.feature.rst b/changes/1867.feature.rst
@@ -0,0 +1 @@
+A new Textual backend was added to support terminal applications.
diff --git a/docs/reference/api/app.rst b/docs/reference/api/app.rst
@@ -5,8 +5,8 @@ Application
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
-   :exclude: {0: '(?!(App|Component))'}
+   :included_cols: 4,5,6,7,8,9,10
+   :exclude: {0: '(?!(Application|Component))'}
 
 The app is the main entry point and container for the Toga GUI.
 

diff --git a/docs/reference/api/containers/box.rst b/docs/reference/api/containers/box.rst
@@ -7,7 +7,7 @@ A generic container for other widgets. Used to construct layouts.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(Box|Component))'}
 
 Usage

diff --git a/docs/reference/api/containers/optioncontainer.rst b/docs/reference/api/containers/optioncontainer.rst
@@ -11,7 +11,7 @@ A container that can display multiple labeled tabs of content.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(OptionContainer|Component))'}
 
 

diff --git a/docs/reference/api/containers/scrollcontainer.rst b/docs/reference/api/containers/scrollcontainer.rst
@@ -12,7 +12,7 @@ overflow controlled by scroll bars.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(ScrollContainer|Component))'}
 
 Usage

diff --git a/docs/reference/api/containers/splitcontainer.rst b/docs/reference/api/containers/splitcontainer.rst
@@ -11,7 +11,7 @@ A container that divides an area into two panels with a movable border.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(SplitContainer|Component))'}
 
 

diff --git a/docs/reference/api/mainwindow.rst b/docs/reference/api/mainwindow.rst
@@ -5,7 +5,7 @@ MainWindow
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(MainWindow|Component))'}
 
 A window for displaying components to the user

diff --git a/docs/reference/api/resources/app_paths.rst b/docs/reference/api/resources/app_paths.rst
@@ -8,7 +8,7 @@ application.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(App Paths|Component)$)'}
 
 Usage

diff --git a/docs/reference/api/resources/command.rst b/docs/reference/api/resources/command.rst
@@ -5,7 +5,7 @@ Command
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(Command|Component))'}
 
 

diff --git a/docs/reference/api/resources/fonts.rst b/docs/reference/api/resources/fonts.rst
@@ -5,7 +5,7 @@ Font
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(Font|Component))'}
 
 The font class is used for abstracting the platforms implementation of fonts.

diff --git a/docs/reference/api/resources/group.rst b/docs/reference/api/resources/group.rst
@@ -5,7 +5,7 @@ Group
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(Group|Component))'}
 
 

diff --git a/docs/reference/api/resources/icons.rst b/docs/reference/api/resources/icons.rst
@@ -5,7 +5,7 @@ Icon
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(Icon|Component))'}
 
 

diff --git a/docs/reference/api/resources/images.rst b/docs/reference/api/resources/images.rst
@@ -5,7 +5,7 @@ Image
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(Image|Component)$)'}
 
 

diff --git a/docs/reference/api/widgets/activityindicator.rst b/docs/reference/api/widgets/activityindicator.rst
@@ -11,7 +11,7 @@ usually rendered as a "spinner" animation.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!^(ActivityIndicator|Component)$)'}
 
 Usage

diff --git a/docs/reference/api/widgets/button.rst b/docs/reference/api/widgets/button.rst
@@ -11,7 +11,7 @@ A button that can be pressed or clicked.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(Button|Component))'}
 
 Usage

diff --git a/docs/reference/api/widgets/canvas.rst b/docs/reference/api/widgets/canvas.rst
@@ -5,7 +5,7 @@ Canvas
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(Canvas|Component))'}
 
 The canvas is used for creating a blank widget that you can draw on.

diff --git a/docs/reference/api/widgets/dateinput.rst b/docs/reference/api/widgets/dateinput.rst
@@ -11,7 +11,7 @@ A widget to select a calendar date.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(DateInput|Component))'}
 
 Usage

diff --git a/docs/reference/api/widgets/detailedlist.rst b/docs/reference/api/widgets/detailedlist.rst
@@ -5,7 +5,7 @@ DetailedList
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(DetailedList|Component))'}
 
 

diff --git a/docs/reference/api/widgets/divider.rst b/docs/reference/api/widgets/divider.rst
@@ -10,7 +10,7 @@ A separator used to visually distinguish two sections of content in a layout.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(Divider|Component))'}
 
 Usage

diff --git a/docs/reference/api/widgets/imageview.rst b/docs/reference/api/widgets/imageview.rst
@@ -5,7 +5,7 @@ ImageView
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!^(ImageView|Component)$)'}
 
 A widget that displays an image.

diff --git a/docs/reference/api/widgets/label.rst b/docs/reference/api/widgets/label.rst
@@ -10,7 +10,7 @@ A text label for annotating forms or interfaces.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!^(Label|Component)$)'}
 
 Usage

diff --git a/docs/reference/api/widgets/multilinetextinput.rst b/docs/reference/api/widgets/multilinetextinput.rst
@@ -11,7 +11,7 @@ A scrollable panel that allows for the display and editing of multiple lines of
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!^(MultilineTextInput|Component)$)'}
 
 Usage

diff --git a/docs/reference/api/widgets/numberinput.rst b/docs/reference/api/widgets/numberinput.rst
@@ -10,7 +10,7 @@ A text input that is limited to numeric input.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!^(NumberInput|Component)$)'}
 
 Usage

diff --git a/docs/reference/api/widgets/passwordinput.rst b/docs/reference/api/widgets/passwordinput.rst
@@ -13,7 +13,7 @@ not the actual characters.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!^(PasswordInput|Component)$)'}
 
 

diff --git a/docs/reference/api/widgets/progressbar.rst b/docs/reference/api/widgets/progressbar.rst
@@ -11,7 +11,7 @@ known or indeterminate length.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!^(ProgressBar|Component)$)'}
 
 Usage

diff --git a/docs/reference/api/widgets/selection.rst b/docs/reference/api/widgets/selection.rst
@@ -10,7 +10,7 @@ A widget to select a single option from a list of alternatives.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!^(Selection|Component)$)'}
 
 

diff --git a/docs/reference/api/widgets/slider.rst b/docs/reference/api/widgets/slider.rst
@@ -12,7 +12,7 @@ and the selected value is shown as a draggable marker.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!^(Slider|Component)$)'}
 
 

diff --git a/docs/reference/api/widgets/switch.rst b/docs/reference/api/widgets/switch.rst
@@ -12,7 +12,7 @@ unchecked). The button has a text label.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!^(Switch|Component)$)'}
 
 Usage

diff --git a/docs/reference/api/widgets/table.rst b/docs/reference/api/widgets/table.rst
@@ -5,7 +5,7 @@ Table
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!^(Table|Component)$)'}
 
 The table widget is a widget for displaying tabular data. It can be instantiated with the list of headings and then data rows

diff --git a/docs/reference/api/widgets/textinput.rst b/docs/reference/api/widgets/textinput.rst
@@ -11,7 +11,7 @@ A widget for the display and editing of a single line of text.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!^(TextInput|Component)$)'}
 
 Usage

diff --git a/docs/reference/api/widgets/timeinput.rst b/docs/reference/api/widgets/timeinput.rst
@@ -11,7 +11,7 @@ A widget to select a clock time.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(TimeInput|Component))'}
 
 Usage

diff --git a/docs/reference/api/widgets/tree.rst b/docs/reference/api/widgets/tree.rst
@@ -5,7 +5,7 @@ Tree
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!^(Tree|Component)$)'}
 
 The tree widget is still under development.

diff --git a/docs/reference/api/widgets/webview.rst b/docs/reference/api/widgets/webview.rst
@@ -10,7 +10,7 @@ An embedded web browser.
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!^(WebView|Component)$)'}
 
 Usage

diff --git a/docs/reference/api/widgets/widget.rst b/docs/reference/api/widgets/widget.rst
@@ -7,7 +7,7 @@ The abstract base class of all widgets. This class should not be be instantiated
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!^(Widget|Component)$)'}
 
 

diff --git a/docs/reference/api/window.rst b/docs/reference/api/window.rst
@@ -5,7 +5,7 @@ Window
 .. csv-filter:: Availability (:ref:`Key <api-status-key>`)
    :header-rows: 1
    :file: ../data/widgets_by_platform.csv
-   :included_cols: 4,5,6,7,8,9
+   :included_cols: 4,5,6,7,8,9,10
    :exclude: {0: '(?!(Window|Component))'}
 
 A window for displaying components to the user