Repository files navigation

Build cross-platform user interfaces with a simple Python API. Run your apps in the terminalor 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 advancedtesting framework ensure you can maintain your app for the long-term.

Want some more examples? See theexamples directory.

"""An App to show the current time."""fromdatetimeimportdatetimefromtextual.appimportApp,ComposeResultfromtextual.widgetsimportDigitsclassClockApp(App):CSS="""    Screen { align: center middle; }    Digits { width: auto; }    """defcompose(self)->ComposeResult:yieldDigits("")defon_ready(self)->None:self.update_clock()self.set_interval(1,self.update_clock)defupdate_clock(self)->None:clock=datetime.now().time()self.query_one(Digits).update(f"{clock:%T}")if__name__=="__main__":app=ClockApp()app.run()

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

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

Install Textual via pip:

pip install textual textual-dev

Seegetting started for details.

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

python -m textual

Or try thetextual demowithout installing (requiresuv):

uvx --python 3.12 textual-demo

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

Thetextual-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.

Seethe guide for other helpful tools provided by thetextual-dev package.

Textual apps have afuzzy search command palette.Hitctrl+p to open the command palette.

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

Textual apps are equally at home in the browser as they are the terminal. Any Textual app may be served withtextual 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 withTextual 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 the Textual developers and community on ourDiscord Server.