# terminal_layout

**Repository Path**: jsmth/terminal_layout

## Basic Information

- **Project Name**: terminal_layout
- **Description**: The project help you to quickly build layouts in terminal (这个一个命令行ui布局工具)
- **Primary Language**: Python
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 7
- **Created**: 2019-02-14
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# terminal_layout

The project help you to quickly build layouts in terminal  
(这个一个命令行ui布局工具)


![](pic/demo.gif)

[![asciicast](https://asciinema.org/a/226120.svg)](https://asciinema.org/a/226120)

# link

* [All Demo](https://github.com/gojuukaze/terminal_layout/tree/master/demo) 
* [GIthub](https://github.com/gojuukaze/terminal_layout) 
* [Docs](https://terminal-layout.readthedocs.io) 
* [https://asciinema.org/a/226120](https://asciinema.org/a/226120) 

# install 
```bash
pip install terminal-layout
```

# Usage

 * easy demo:

```python
import time
from terminal_layout import *

ctl = LayoutCtl(TextView('id1', 'hello world!', width=20, fore=Fore.red, back=Back.green))

ctl.draw()

time.sleep(2)

view = ctl.find_view_by_id('id1')
view.text = 'hi world'
ctl.re_draw()


```
![](pic/hello.png)



 * use table layout:

```python
from terminal_layout import *

ctl = LayoutCtl.quick(TableLayout,
                [
                    [TextView('title', 'Student', fore=Fore.black, back=Back.yellow, width=17,
                              gravity=Gravity.center)],

                    [TextView('', 'No.', width=5, back=Back.yellow),
                     TextView('', 'Name', width=12, back=Back.yellow)],

                    [TextView('st1_no', '1', width=5, back=Back.yellow),
                     TextView('st1_name', 'Bob', width=12, back=Back.yellow)],

                    [TextView('stw_no', '2', width=5, back=Back.yellow),
                     TextView('st1_name', 'Tom', width=12, back=Back.yellow)]
                ]
                
                )
                
ctl.draw()

```

![](pic/table.png)

 * 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()

```

![](pic/py2.png)


## Properties

属性说明

 * fore & back
 
```python
TextView('','fore',fore=Fore.red)
TextView('','back',back=Back.red)
```
<img width="560" src="pic/color.jpeg"/>

 * style

```python
TextView('','style',style=Style.dim)
```
<img width="560" src="pic/style.jpeg"/>

 * width
 
```python
TextView('','width',width=10)
```
<img width="560" src="pic/width.jpeg"/>


 * weight
 
```python
TextView('','weight',weight=1)
```
<img width="560" src="pic/weight.jpeg"/>


 * gravity
 
```python
TextView('','gravity',gravity=Gravity.left)
```
<img width="560" src="pic/gravity.jpeg"/>


 * visibility
 
```python
TextView('','',visibility=Visibility.visible)
```
<img width="560" src="pic/visibility.jpeg"/>


 * ex_style (not support windows)


```python
TextView('','ex_style',style=Style.ex_blink)
```
<img width="560" src="pic/ex_style.jpeg"/>

 * ex_fore & ex_back (not support windows)


```python
TextView('','ex_fore',fore=Fore.ex_red_1)
TextView('','ex_back',back=Back.ex_red_1)

```
<img width="560" src="pic/ex_color.jpeg"/>



# 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