mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
54 lines
1.8 KiB
Markdown
54 lines
1.8 KiB
Markdown
All you need to get started building Textual apps.
|
|
|
|
## Requirements
|
|
|
|
Textual requires Python 3.7 or later (if you have a choice, pick the most recent Python). Textual runs on Linux, macOS, Windows and probably any OS where Python also runs.
|
|
|
|
!!! info inline end "Your platform"
|
|
|
|
### :fontawesome-brands-linux: Linux (all distros)
|
|
|
|
All Linux distros come with a terminal emulator that can run Textual apps.
|
|
|
|
### :material-apple: macOS
|
|
|
|
The default terminal app is limited to 256 colors. We recommend installing a newer terminal such as [iterm2](https://iterm2.com/), [Kitty](https://sw.kovidgoyal.net/kitty/), or [WezTerm](https://wezfurlong.org/wezterm/).
|
|
|
|
### :material-microsoft-windows: Windows
|
|
|
|
The new [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701?hl=en-gb&gl=GB) runs Textual apps beautifully.
|
|
|
|
## Installation
|
|
|
|
You can install Textual via PyPI.
|
|
|
|
If you plan on developing Textual apps, then you should install `textual[dev]`. The `[dev]` part installs a few extra dependencies for development.
|
|
|
|
```
|
|
pip install "textual[dev]==0.2.0b7"
|
|
```
|
|
|
|
If you only plan on _running_ Textual apps, then you can drop the `[dev]` part:
|
|
|
|
```
|
|
pip install textual==0.2.0b7
|
|
```
|
|
|
|
!!! important
|
|
|
|
There may be a more recent beta version since the time of writing. Check the [release history](https://pypi.org/project/textual/#history) for a more recent version.
|
|
|
|
## Textual CLI
|
|
|
|
If you installed the dev dependencies you have access to the `textual` CLI command. There are a number of sub-commands which will aid you in building Textual apps.
|
|
|
|
```bash
|
|
textual --help
|
|
```
|
|
|
|
See [devtools](guide/devtools.md) for more about the `textual` command.
|
|
|
|
## Need help?
|
|
|
|
See the [help](./help.md) page for how to get help with Textual, or to report bugs.
|