Giter Site home page Giter Site logo

tonybaloney / textual Goto Github PK

View Code? Open in Web Editor NEW

This project forked from textualize/textual

0.0 2.0 0.0 125.16 MB

Textual is a TUI (Text User Interface) framework for Python inspired by modern web development.

Home Page: https://textual.textualize.io/

License: MIT License

Python 97.98% TypeScript 0.36% CSS 0.80% Makefile 0.04% Jinja 0.83%

textual's Introduction

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.

Screen.Recording.2022-10-22.at.19.00.48.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).

Screen.Recording.2022-10-21.at.12.41.15.mov
๐Ÿ“ท Calculator

This is calculator.py which demonstrates Textual grid layouts.

calculator screenshot

๐ŸŽฌ Stopwatch

This is the Stopwatch example from the tutorial.

Screen.Recording.2022-10-22.at.21.12.22.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
Screen.Recording.2022-10-17.at.11.38.13.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
Screen.Recording.2022-10-17.at.11.44.24.mov
๐ŸŽฌ Colors reference

This is a reference for Textual's color design system.

textual colors
Screen.Recording.2022-10-22.at.19.07.20.mov

textual's People

Contributors

willmcgugan avatar darrenburns avatar davep avatar rodrigogiraoserrao avatar olivierphi avatar aaronst avatar nitzan-shaked avatar overflowy avatar lllama avatar driscollis avatar tusharsadhwani avatar uriyaharpeness avatar kimvanwyk avatar jspv avatar ofek avatar joshkarpel avatar 1ace avatar ahopkins avatar martinthoma avatar mattkram avatar matrixmanatyrservice avatar mhils avatar mbridak avatar noblysp avatar kajuberdut avatar sanders41 avatar pvmm avatar bryophyta avatar ramiro avatar rjmill avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.