1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
---
hide:
- toc
- navigation
---
!!! tip inline end
See the navigation links in the header or side-bar.
Click :octicons-three-bars-16: (top left) on mobile.
# Welcome
Welcome to the [Textual](https://github.com/Textualize/textual) framework documentation.
[Get started](./getting_started.md){ .md-button .md-button--primary } or go straight to the [Tutorial](./tutorial.md)
## What is Textual?
Textual is a *Rapid Application Development* framework for Python, built by [Textualize.io](https://www.textualize.io).
Build sophisticated user interfaces with a simple Python API. Run your apps in the terminal *or* a [web browser](https://github.com/Textualize/textual-web)!
<div class="grid cards" markdown>
- :material-clock-fast:{ .lg .middle } :material-language-python:{. lg .middle } __Rapid development__
---
Uses your existing Python skills to build beautiful user interfaces.
- :material-raspberry-pi:{ .lg .middle } __Low requirements__
---
Run Textual on a single board computer if you want to.
- :material-microsoft-windows:{ .lg .middle } :material-apple:{ .lg .middle } :fontawesome-brands-linux:{ .lg .middle } __Cross platform__
---
Textual runs just about everywhere.
- :material-network:{ .lg .middle } __Remote__
---
Textual apps can run over SSH.
- :fontawesome-solid-terminal:{ .lg .middle } __CLI Integration__
---
Textual apps can be launched and run from the command prompt.
- :material-scale-balance:{ .lg .middle } __Open Source__
---
Textual is licensed under MIT.
</div>
---
# Live Demo
The official [Textual demo](https://github.com/textualize/textual-demo).
<div class="textual-web-demo" data-app="demo"></div>
---
# Built with Textual
Textual has enabled an ecosystem of applications and tools for developers and non-developers alike.
Here are a few examples.
## Posting
The API client that lives in your terminal.
Posting is a beautiful open-source terminal app for developing and testing APIs.
[Posting Website](https://posting.sh/)
[Posting Github Repository](https://github.com/darrenburns/posting)
<div>
<a href="https://posting.sh">
--8<-- "docs/images/screenshots/posting.svg"
</a>
</div>
---
## Toolong
A terminal application to view, tail, merge, and search log files (plus JSONL).
[Toolong Github Repository](https://github.com/textualize/toolong)
<div>
<a href="https://github.com/Textualize/toolong">
--8<-- "docs/images/screenshots/toolong.svg"
</a>
</div>
---
## Memray
Memray is a memory profiler for Python, built by Bloomberg.
[Memray Github Repository](https://github.com/bloomberg/memray)
<div>
<a href="https://github.com/bloomberg/memray">
--8<-- "docs/images/screenshots/memray.svg"
</a>
</div>
---
## Dolphie
Your single pane of glass for real-time analytics into MySQL/MariaDB & ProxySQL
[Dolphie Github Repository](https://github.com/charles-001/dolphie)
<div>
<a href="https://github.com/charles-001/dolphie">
--8<-- "docs/images/screenshots/dolphie.svg"
</a>
</div>
---
## Harlequin
An easy, fast, and beautiful database client for the terminal.
[Harlequin website](https://harlequin.sh/)
<div>
<a href="https://harlequin.sh">
--8<-- "docs/images/screenshots/harlequin.svg"
</a>
</div>
---
# Examples
The following examples are taken from the [examples directory](https://github.com/Textualize/textual/tree/main/examples).
Click the tabs to see the code behind the example.
=== "Pride example"
```{.textual path="examples/pride.py"}
```
=== "pride.py"
```py
--8<-- "examples/pride.py"
```
---
=== "Calculator example"
```{.textual path="examples/calculator.py" columns=100 lines=41 press="6,.,2,8,3,1,8,5,3,0,7,1,wait:400"}
```
=== "calculator.py"
```python
--8<-- "examples/calculator.py"
```
=== "calculator.tcss"
```css
--8<-- "examples/calculator.tcss"
```
|
