Skip to main content

Modern Text User Interface framework

Project description

Textual

Textual splash image

Textual is a Python framework for creating interactive applications that run in your terminal.

🎬 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 a Python 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!

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.10.1.tar.gz (250.4 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.10.1-py3-none-any.whl (298.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: textual-0.10.1.tar.gz
  • Upload date:
  • Size: 250.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.4 Darwin/22.2.0

File hashes

Hashes for textual-0.10.1.tar.gz
Algorithm Hash digest
SHA256 928cfeec37c60b212963f484e806b25380afdddb5a2aecd888ce8c9b46f93553
MD5 bea81d921151fcb14b382c6aadf7c92e
BLAKE2b-256 09b41bffcb47a7d9859e4a3dae84fcb60efde276d5d9309a0e3cb672defd4cf8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: textual-0.10.1-py3-none-any.whl
  • Upload date:
  • Size: 298.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.4 Darwin/22.2.0

File hashes

Hashes for textual-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dd9a5b38a74cf42364a0f247e8f57e3ded7d69d44a63ee664af333f986c48e81
MD5 88ccdccccb2016940309780da6fc338c
BLAKE2b-256 132df196fb678e5f9305099262d07ecd9c5e8ecca12d4e9b54e0a1d6b05821e7

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