Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chhsiao90/gviewer
Simple, Light Weight, but Powerful Terminal UI Library for Python
https://github.com/chhsiao90/gviewer
tui urwid
Last synced: 22 days ago
JSON representation
Simple, Light Weight, but Powerful Terminal UI Library for Python
- Host: GitHub
- URL: https://github.com/chhsiao90/gviewer
- Owner: chhsiao90
- License: mit
- Created: 2016-06-23T09:18:58.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-09-15T06:24:42.000Z (about 8 years ago)
- Last Synced: 2024-08-10T09:13:29.279Z (3 months ago)
- Topics: tui, urwid
- Language: Python
- Homepage:
- Size: 211 KB
- Stars: 10
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# General Viewer (GViewer)
[](https://travis-ci.org/chhsiao90/gviewer)
[](https://coveralls.io/github/chhsiao90/gviewer?branch=master)
**Simple, Light Weight, Powerful**
GViewer is a terminal UI library that depends on [urwid](https://github.com/urwid/urwid) simplified writing a tui based reporting system.
You could write a powerful terminal UI that display and operate with data as you want with just less and less code.
## Installation
```shell
pip install gviewer
```
## Run Example
There are some example in examples that provide some use cases.
You could see and run the examples.
```shell
python examples/panama.py
```
## Usage
### Data Store
####StaticDataStore
Used for static data list, like log file
Initiate with a list of eny type of content
The content will transfer to the your defined displayer later for display
```python
from gviewer import StaticDataStore
data_store = StaticDataStore(data)
```
#### AsyncDataStore
Used for asynchronous data list, like subscribe an [zeromq](http://zeromq.org/) publisher
```python
def register_func(on_message):
some_listener.on_message(on_message)
data_store = AsyncDataStore(register_func)
```
### Displayer
Defined how you display your data from Data Store to summary/details
```python
from gviewer import BaseDisplayer, View, Group, PropsGroup, Text, Prop
class MyDisplayer(BaseDisplayer):
def to_summary(self, message):
"""
return a str or text markup
reference: http://urwid.org/manual/displayattributes.html#text-markup
"""
return message["summary"]
def get_views(self):
"""return an array of tuple that contains view title and a function that transform message to detail"""
return [
("view1", self.view1),
("view2", self.view2),
]
def view1(self, message):
"""return groups"""
return View(
[Group("title", [Text(m) for m in message["view1"]])]
)
def view2(self, message):
"""return groups"""
return View(
[PropsGroup("title", [Prop(p[0], p[1]) for p in message["view2"]])]
)
```
### GViewer
Main class to start the tui
The constructor accept any of urwid.MainLoop arguments to intiate with custom config
```python
from gviewer import GViewer, DisplayerContext
context = DisplayerContext(data_store, displayer)
viewer = GViewer(context)
viewer.start()
```
## Advanced Usage
### Summary Actions
Bind function to specific key to apply customize action, ex: export
```python
from gviewer import GViewer, DisplayerContext
def custom_export(controller, message, widget, *args, **kwargs):
with open("export", "w") as f:
f.write(str(message))
controller.notify("file is export")
context = DisplayerContext(data_store, displayer, actions=Actions([("a", "Custom export", custom_export)]))
viewer = GViewer(context)
```
### View Actions
Bind function to specific key to apply customize action, ex: export
```python
from gviewer import View, BaseDisplayer
class MyDisplayer(BaseDisplayer):
def get_views(self):
return [("view", self.view)]
def view(self, message):
return View([], actions=Actions([("a", "Custom export", self.custom_export)]))
def custom_export(controller, message, *args, **kwargs):
with open("export", "w") as f:
f.write(str(message))
controller.notify("file is export")
```
## Built-in actions
### Summary
- /: search
- g: top
- G: bottom
- x: clear current item
- X: clear all items
- q: quit
- ?: help
### Detail
- /: search
- tab: next view
- shift+tab: prev view
- n: search next result
- N: search previous result
- e: export current content to file
- q: quit
- ?: help
## Contribution
Please feel free to create issue or create PR