https://github.com/gojuukaze/terminal_layout
The project help you to quickly build layouts in terminal，cross-platform(一个跨平台的命令行ui布局工具)
https://github.com/gojuukaze/terminal_layout
choice cli cli-app cmd command-line command-line-interface command-line-tool inquirer loading progress progress-bar prompt-toolkit pyinquirer select terminal-colors terminal-ui
Last synced: about 1 month ago
JSON representation
The project help you to quickly build layouts in terminal，cross-platform(一个跨平台的命令行ui布局工具)
- Host: GitHub
- URL: https://github.com/gojuukaze/terminal_layout
- Owner: gojuukaze
- License: gpl-3.0
- Created: 2019-01-17T15:44:21.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-04T00:59:02.000Z (over 2 years ago)
- Last Synced: 2025-11-03T17:39:03.535Z (4 months ago)
- Topics: choice, cli, cli-app, cmd, command-line, command-line-interface, command-line-tool, inquirer, loading, progress, progress-bar, prompt-toolkit, pyinquirer, select, terminal-colors, terminal-ui
- Language: Python
- Homepage:
- Size: 3.94 MB
- Stars: 149
- Watchers: 6
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.ZH.md
- License: LICENSE
Awesome Lists containing this project
README
# terminal_layout
The project help you to quickly build layouts in terminal
(这个一个命令行ui布局工具)
----------------
**基于terminal_layout的扩展**
* [progress](terminal_layout/extensions/progress/README.md)
* [choice](terminal_layout/extensions/choice/README.md)
-------------------
** video demo **
# link
* [Github](https://github.com/gojuukaze/terminal_layout)
* [文档](https://doc.ikaze.cn/terminal_layout/)
* [https://asciinema.org/a/226120](https://asciinema.org/a/226120)
# 安装
```bash
pip install terminal-layout
```
# 依赖
* Python 2.7, 3.5+ (maybe 3.4)
* Linux, OS X, and Windows systems.
# Usage
* easy demo:
```python
import time
from terminal_layout import *
ctl = LayoutCtl.quick(TableLayout,
# table id: root
[
[TextView('t1', 'Hello World!', width=Width.fill, back=Back.blue)], # <- row id: root_row_00,
[TextView('t2', '', fore=Fore.magenta)], # <- row id: root_row_1,
],
)
# or layout=ctl.get_layout()
layout = ctl.find_view_by_id('root')
layout.set_width(20)
# default: auto_re_draw=True
ctl.draw()
# 如果使用delay_set_text(), 必须把auto_re_draw设为True，否则你需要自己在线程中执行re_draw()
ctl.find_view_by_id('t2').delay_set_text('你好,世界!', delay=0.2)
time.sleep(0.5)
row3 = TableRow.quick_init('', [TextView('t3', 'こんにちは、世界!')])
layout.add_view(row3)
# 如果执行draw()时auto_re_draw=True，你必须执行stop()
ctl.stop()
```
* 禁用 auto_re_draw
```python
import time
from terminal_layout import *
ctl = LayoutCtl.quick(TableLayout,
[
[TextView('t1', 'Hello World!', width=Width.fill, back=Back.blue)],
[TextView('t2', '', fore=Fore.magenta)],
],
)
layout = ctl.find_view_by_id('root')
layout.set_width(20)
ctl.draw(auto_re_draw=False)
ctl.find_view_by_id('t2').set_text('你好,世界!')
ctl.re_draw()
time.sleep(0.5)
row3 = TableRow.quick_init('', [TextView('t3', 'こんにちは、世界!')])
layout.add_view(row3)
ctl.re_draw()
# 不需执行stop()
# ctl.stop()
```
* use python2 unicode
```python
# -*- coding: utf-8 -*-
from terminal_layout import *
import sys
reload(sys)
sys.setdefaultencoding('utf-8')
ctl = LayoutCtl.quick(TableLayout,
[
[TextView('', u'中文，你好', back=Back.cyan, width=Width.wrap)],
[TextView('', u'中文，你好', back=Back.cyan, width=6)],
[TextView('', u'日本語，こんにちは', back=Back.cyan, width=Width.wrap)],
]
)
ctl.draw()
```
## View的属性
* fore & back
```python
TextView('','fore',fore=Fore.red)
TextView('','back',back=Back.red)
```
* style
```python
TextView('','style',style=Style.dim)
```
* width
```python
TextView('','width',width=10)
```
* weight
```python
TextView('','weight',weight=1)
```
* gravity
```python
TextView('','gravity',gravity=Gravity.left)
```
* visibility
```python
TextView('','',visibility=Visibility.visible)
```
* ex_style (not support windows)
```python
TextView('','ex_style',style=Style.ex_blink)
```
* ex_fore & ex_back (not support windows)
```python
TextView('','ex_fore',fore=Fore.ex_red_1)
TextView('','ex_back',back=Back.ex_red_1)
```
# LICENSE
[GPLv3](https://github.com/gojuukaze/terminal_layout/blob/master/LICENSE)
# Thanks
* [colorama](https://github.com/tartley/colorama) : Simple cross-platform colored terminal text in Python
* [colored](https://gitlab.com/dslackw/colored) : Very simple Python library for color and formatting in terminal