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.

🎬 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/196156524-5edea78c-1226-4103-91f3-e82d6a52bd2b.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.

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

Examples

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

📷 Calculator

This is calculator.py which demonstrates Textual grid layouts.

calculator screenshot

📷 Code browser

This is code_browser.py which demonstrates the directory tree widget.

code browser screenshot

📷 Stopwatch

This is the Stopwatch example from the tutorial.

Light theme

stopwatch light screenshot

Dark theme

stopwatch dark screenshot

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.2.0b8.tar.gz (220.8 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.2.0b8-py3-none-any.whl (263.6 kB view details)

Uploaded Python 3

File details

Details for the file textual-0.2.0b8.tar.gz.

File metadata

  • Download URL: textual-0.2.0b8.tar.gz
  • Upload date:
  • Size: 220.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.4 Darwin/21.6.0

File hashes

Hashes for textual-0.2.0b8.tar.gz
Algorithm Hash digest
SHA256 4898f8ccb7ff11fd77f508aaab8a159b86c98e8e039d9416d84b9e9956248ffb
MD5 e1cd0b8bf1b4c85da7e82f192534a760
BLAKE2b-256 6d755b2919dd5dd0108bfd9d9ca1101aaa9344cdd3bc464a1cedb15e42b45393

See more details on using hashes here.

File details

Details for the file textual-0.2.0b8-py3-none-any.whl.

File metadata

  • Download URL: textual-0.2.0b8-py3-none-any.whl
  • Upload date:
  • Size: 263.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.4 Darwin/21.6.0

File hashes

Hashes for textual-0.2.0b8-py3-none-any.whl
Algorithm Hash digest
SHA256 786f3e40dad1540bcd7b95e72941eb2bf25d3742644be99de1efd2c95cf279fd
MD5 8d7f120d6c09bbd15ea8a762895d2e21
BLAKE2b-256 49af4a37db0c32e2b101e9f6da3619f87eb6f329ff48d014c9a3bab27fd7cb2f

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