Skip to main content

Modern Text User Interface framework

Project description

Textual splash image

Discord

Textual

Textual is a Rapid Application Development framework for Python.

Build sophisticated user interfaces with a simple Python API. Run your apps in the terminal and (coming soon) a web browser!

🎬 Demonstration

A quick run through of some Textual features.

https://user-images.githubusercontent.com/554369/197355913-65d3c125-493d-4c05-a590-5311f16c40ff.mov

About

Textual adds interactivity to Rich with an API inspired by modern web development.

On modern terminal software (installed by default on most systems), Textual apps can use 16.7 million colors with mouse support and smooth flicker-free animation. A powerful layout engine and re-usable components makes it possible to build apps that rival the desktop and web experience.

Compatibility

Textual runs on Linux, macOS, and Windows. Textual requires Python 3.7 or above.

Installing

Install Textual via pip:

pip install "textual[dev]"

The addition of [dev] installs Textual development tools. See the docs if you need help getting started.

Demo

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

python -m textual

Textual demo

Documentation

Head over to the Textual documentation to start building!

Join us on Discord

Join the Textual developers and community on our Discord Server.

Examples

The Textual repository comes with a number of examples you can experiment with or use as a template for your own projects.

🎬 Code browser

This is the code_browser.py example which clocks in at 61 lines (including docstrings and blank lines).

https://user-images.githubusercontent.com/554369/197188237-88d3f7e4-4e5f-40b5-b996-c47b19ee2f49.mov

📷 Calculator

This is calculator.py which demonstrates Textual grid layouts.

calculator screenshot

🎬 Stopwatch

This is the Stopwatch example from the tutorial.

https://user-images.githubusercontent.com/554369/197360718-0c834ef5-6285-4d37-85cf-23eed4aa56c5.mov

Reference commands

The textual command has a few sub-commands to preview Textual styles.

🎬 Easing reference

This is the easing reference which demonstrates the easing parameter on animation, with both movement and opacity. You can run it with the following command:

textual easing

https://user-images.githubusercontent.com/554369/196157100-352852a6-2b09-4dc8-a888-55b53570aff9.mov

🎬 Borders reference

This is the borders reference which demonstrates some of the borders styles in Textual. You can run it with the following command:

textual borders

https://user-images.githubusercontent.com/554369/196158235-4b45fb78-053d-4fd5-b285-e09b4f1c67a8.mov

🎬 Colors reference

This is a reference for Textual's color design system.

textual colors

https://user-images.githubusercontent.com/554369/197357417-2d407aac-8969-44d3-8250-eea45df79d57.mov

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

textual-0.28.1.tar.gz (817.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

textual-0.28.1-py3-none-any.whl (418.0 kB view details)

Uploaded Python 3

File details

Details for the file textual-0.28.1.tar.gz.

File metadata

  • Download URL: textual-0.28.1.tar.gz
  • Upload date:
  • Size: 817.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.11.1 Darwin/22.4.0

File hashes

Hashes for textual-0.28.1.tar.gz
Algorithm Hash digest
SHA256 f63a873d810b5d01f7318d8eb8f706d530550f3a90a6892628d17d47ecefcd41
MD5 a045496b809322f3224ead9d6cf2f709
BLAKE2b-256 52b8907d8027a67b73619931c34f4403b7e7a4d0253e074f1205871f9c1ee302

See more details on using hashes here.

File details

Details for the file textual-0.28.1-py3-none-any.whl.

File metadata

  • Download URL: textual-0.28.1-py3-none-any.whl
  • Upload date:
  • Size: 418.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.11.1 Darwin/22.4.0

File hashes

Hashes for textual-0.28.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cb6f6230fea390178f8e727d2f9e542337a655549ea44331e22336da799a900f
MD5 4737e9a5b950f0c4836d94a325a00ccd
BLAKE2b-256 9c503048d1274f9ad9ca97f4556047c1ab7120f0296a31bcb0a4a2890252bd0b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page