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 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.8 or above.

Installing

Install Textual via pip:

pip install textual

If you plan on developing Textual apps, you should also install the development tools with the following command:

pip install textual-dev

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.86.3.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

textual-0.86.3-py3-none-any.whl (647.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: textual-0.86.3.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.7 Darwin/24.0.0

File hashes

Hashes for textual-0.86.3.tar.gz
Algorithm Hash digest
SHA256 3c4d68612243af351e8b2d3dabe44d3cf87624624d7ea657f4d718853206188f
MD5 6c17f02f2315003ef7a70b3593a98021
BLAKE2b-256 4aa6c62991e51e3030a7e0bfb196f22c9c57a36257d52b09f6a6b6c78aaa6508

See more details on using hashes here.

File details

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

File metadata

  • Download URL: textual-0.86.3-py3-none-any.whl
  • Upload date:
  • Size: 647.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.7 Darwin/24.0.0

File hashes

Hashes for textual-0.86.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ffe85bc749de7d71e0e048af301b6027abfca8942263ffb680620261cd1baa6f
MD5 2dc217c3b69b6b004cff255185118cbf
BLAKE2b-256 df7782e0593c98895e7bc18f15323c353d30e74fc0d2096a6d326fc31fddcc88

See more details on using hashes here.

Supported by

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