Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Library for easily creating text interfaces that look like Linux's top program.

Project description

https://img.shields.io/pypi/v/topshape.svg https://img.shields.io/travis/mchlumsky/topshape.svg Documentation Status Updates Python 3 https://codecov.io/gh/mchlumsky/topshape/branch/master/graph/badge.svg

Library for easily creating text interfaces that look like Linux’s top program.

It is built on top of urwid but requires no knowledge of urwid itself.

Quickstart

Here’s an example of how to use TopShape:

from topshape import TopShape


# The columns are a list (or tuple) of dictionaries. Each
# dictionary defines a column in the body
columns = ({'label': 'header1'},
           {'label': 'header2'},
           {'label': 'header3'})


# The body function will be passed as a callback that must
# return a 2-dimensional array everytime it's called.
def body():
    return [[str(i*j) for i in range(3)] for j in range(10)]


# The header function will be passed as a callback that must
# return a string everytime it's called.
def header():
    return 'This is the header!'


# The footer function will be passed as a callback that must
# return a string everytime it's called.
def footer():
    return 'This is the footer!'


def handle_q(app):
    app.exit()

def handle_f(app, answer):
    # do something with the answer
    # ...

# key_map maps keys pressed to callbacks
key_map = {'q': handle_q,
           'f': (handle_f, 'Enter some text here:'}

app = TopShape.create_app(columns, body, header, footer,
                          key_mapping=key_map)
app.run()

Output:

https://raw.githubusercontent.com/mchlumsky/topshape/master/docs/example1.png

Output (waiting for input from user):

https://raw.githubusercontent.com/mchlumsky/topshape/master/docs/example1-1.png

There is also a more complete example here which is a clone of the linux top program.

Screenshot:

https://raw.githubusercontent.com/mchlumsky/topshape/master/docs/example2.png

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for topshape, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size topshape-1.0.0-py2.py3-none-any.whl (10.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size topshape-1.0.0.tar.gz (102.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page