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/189394703-364b5caa-97e0-45db-907d-7b1620d6411f.mov

About

Textual adds interactivity to Rich with a Python API inspired by modern development 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/189485538-31e794ff-61d7-4faf-902a-6e90a9d76e5b.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/189485735-cb2b4135-caee-46d7-a118-66cd7ed9eef5.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.0b5.tar.gz (208.2 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.0b5-py3-none-any.whl (249.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: textual-0.2.0b5.tar.gz
  • Upload date:
  • Size: 208.2 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.0b5.tar.gz
Algorithm Hash digest
SHA256 54282897a642038b22ad1c208b11b2e02b81dc957a1b3c42cbb8da154cdbc8d3
MD5 2ecd99bf9e6f57e27a3919b14632747f
BLAKE2b-256 5ba45c99261076fa11e074cf2b654541f923287341ee7eb2a21bb98d6a004ef5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: textual-0.2.0b5-py3-none-any.whl
  • Upload date:
  • Size: 249.0 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.0b5-py3-none-any.whl
Algorithm Hash digest
SHA256 348465b77ed53fd0cd6ba24d7bede0be4c2b10f3b5bba1efd08fabfb9c3a0d3b
MD5 e24526de88ada048a9e34648723e901e
BLAKE2b-256 3db5b89a93d609915c8c24a2dacb3cefac7c6b577c4a298e4c75fa8a9aa12763

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