All you need to get started building Textual apps.
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.
Linux (all distros)
All Linux distros come with a terminal emulator that can run Textual apps.
The default terminal app is limited to 256 colors. We recommend installing a newer terminal such as iterm2, Kitty, or WezTerm.
The new Windows Terminal runs Textual apps beautifully.
You can install Textual via PyPI.
If you plan on developing Textual apps, then you should install
[dev] part installs a few extra dependencies for development.
pip install "textual[dev]"
If you only plan on running Textual apps, then you can drop the
Once you have Textual installed, run the following to get an impression of what it can do:
If Textual is installed you should see the following:
The Textual repository comes with a number of example apps. To try out the examples, first clone the Textual repository:
With the repository cloned, navigate to the
/examples/ directory where you will find a number of Python files you can run from the command line:
python code_browser.py ../
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.
See devtools for more about the
See the help page for how to get help with Textual, or to report bugs.