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.0b3.tar.gz (206.3 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.0b3-py3-none-any.whl (247.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: textual-0.2.0b3.tar.gz
  • Upload date:
  • Size: 206.3 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.0b3.tar.gz
Algorithm Hash digest
SHA256 a176e2af5ff17f913858fe5cef7214a5fdf387b878ab1c04e06e45b8620910ea
MD5 fa62fe0ebfbca8b5542d9fba892eb903
BLAKE2b-256 58ef39ab5b560d4758f7ede218c1d17b248b1282b77ce782ec870f56d3ce8e03

See more details on using hashes here.

File details

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

File metadata

  • Download URL: textual-0.2.0b3-py3-none-any.whl
  • Upload date:
  • Size: 247.1 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.0b3-py3-none-any.whl
Algorithm Hash digest
SHA256 8dbfe0eb357a0a604dbb21cd2c30d517596eda31981ec2bc336d544cb74d31f7
MD5 aeb2e232c9f05f9ce1d568534cc1fe3b
BLAKE2b-256 5112419610af6ee972ca729b145295228d155710ffa0710b17c809eb71b47b7d

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