textual README

The project's README from github.com/Textualize/textual. As one markdown file: README.md.

Discord Supported Python Versions PyPI version OS support

textual-splash

Textual

clock

Build cross-platform user interfaces with a simple Python API. Run your apps in the terminal or a web browser.

Textual's API combines modern Python with the best of developments from the web world, for a lean app development experience. De-coupled components and an advanced testing framework ensure you can maintain your app for the long-term.

Want some more examples? See the examples directory.

"""
An App to show the current time.
"""

from datetime import datetime

from textual.app import App, ComposeResult
from textual.widgets import Digits


class ClockApp(App):
    CSS = """
    Screen { align: center middle; }
    Digits { width: auto; }
    """

    def compose(self) -> ComposeResult:
        yield Digits("")

    def on_ready(self) -> None:
        self.update_clock()
        self.set_interval(1, self.update_clock)

    def update_clock(self) -> None:
        clock = datetime.now().time()
        self.query_one(Digits).update(f"{clock:%T}")


if __name__ == "__main__":
    app = ClockApp()
    app.run()

[!TIP] Textual is an asynchronous framework under the hood. Which means you can integrate your apps with async libraries — if you want to. If you don't want or need to use async, Textual won't force it on you.

Widgets

Textual's library of widgets covers everything from buttons, tree controls, data tables, inputs, text areas, and more… Combined with a flexible layout system, you can realize any User Interface you need.

Predefined themes ensure your apps will look good out of the box.

buttons

tree

datatables

inputs

listview

textarea

Installing

Install Textual via pip:

pip install textual textual-dev

See getting started for details.

Demo

Run the following command to see a little of what Textual can do:

python -m textual

Or try the textual demo without installing (requires uv):

uvx --python 3.12 textual-demo

Dev Console

devtools

How do you debug an app in the terminal that is also running in the terminal?

The textual-dev package supplies a dev console that connects to your application from another terminal. In addition to system messages and events, your logged messages and print statements will appear in the dev console.

See the guide for other helpful tools provided by the textual-dev package.

Command Palette

Textual apps have a fuzzy search command palette. Hit ctrl+p to open the command palette.

It is easy to extend the command palette with custom commands for your application.

Command Palette

Textual ❤️ Web

textual-serve

Textual apps are equally at home in the browser as they are the terminal. Any Textual app may be served with textual serve — so you can share your creations on the web. Here's how to serve the demo app:

textual serve "python -m textual"

In addition to serving your apps locally, you can serve apps with Textual Web.

Textual Web's firewall-busting technology can serve an unlimited number of applications.

Since Textual apps have low system requirements, you can install them anywhere Python also runs. Turning any device into a connected device. No desktop required!

Join us on Discord

Join the Textual developers and community on our Discord Server.

textual (Textualize/textual)

Searching Database…

37.5K ·GitHub
Textual
Что это такое?Textual — это лёгкий фреймворк для создания приложений на Python: вы собираете текстовые пользовательские интерфейсы через простой Python API, а готовые приложения работают и в терминале, и в веб-браузере.
Это фреймворк, на котором я строю приложения, или само приложение?Это фреймворк, а не готовое приложение: вы пишете интерфейс на Python, а Textual его отрисовывает. Его API сочетает современный Python с идеями из веб-мира, чтобы разработка оставалась лёгкой.
Как его установить и посмотреть, что он умеет?Установите его через pip, а затем запустите демо-команду ('textual') из README, чтобы увидеть часть его возможностей. Если у вас есть uv, демо можно попробовать даже без установки Textual.
Мне нужно писать асинхронный код, чтобы им пользоваться?Нет — достаточно обычного Python. Внутри Textual работает асинхронно, но использовать async не обязательно, и он не станет навязывать вам асинхронность.
В чём подвох запуска интерфейса внутри терминала?Главная сложность — отладка: приложение занимает терминал, поэтому следить за его выводом прямо там не получится. Отдельный пакет textual-dev даёт консоль разработчика в другом терминале, где видны события, логи и вывод print.
Могу ли я писать автоматические тесты для своего приложения?Да. В Textual встроен развитый фреймворк для тестирования, а его компоненты слабо связаны между собой, так что приложение удобно поддерживать долгосрочно.
Для чего нужна палитра команд на ctrl+p?В каждом приложении Textual есть палитра команд с нечётким поиском, вызываемая по ctrl+p, и её легко расширять собственными командами для вашего приложения.
Проект активно поддерживается?Похоже, что да: создан в апреле 2021 года, около 37.4k звёзд, не архивирован, есть CI-процессы для форматирования, CodeQL и упаковки Python. Также есть активное сообщество в Discord.
What are similar projects?FTXUI, rich, ratatui, ava, iced, tui-rs, lazy.nvim, gitui
Which topics is it in?rich, widgets, async, tui, ui-components, testing, ui, framework, terminal, cli, python, web
Creator
Textualize
Size
485 MB
Stars
37.5K
Updated
CommitOct 09Releasev8.2.8Jun 30
Age
5y
Commits · 90 Days