Skip to main content

Toolkit for quickly building nice looking command line interfaces

Project description

Py-clui

This is a Python toolkit for quickly building nice looking command line interfaces.

Build Status Code style: black

It also includes the following easy to use components:

  • Spinners
  • Gauge
  • Progress

Spinner(message, style=None)

Picture of a spinner

Parameters

  • message - The default status text to display while the spinner is spinning.
  • style - Array of graphical characters used to draw the spinner. By default, on Windows: ['|', '/', '-', ''], on other platforms: ['◜','◠','◝','◞','◡','◟']

Methods

  • run() - Show the spinner on the screen.
  • update_msg(message) - Update the status message that follows the spinner.

Example

from py_clui import Spinner

spinner = Spinner('Processing documents...')
spinner.run()

for x in range(100):
    spinner.update_msg('{0} Processed documents'.format(x))
    spinner.run()

Gauge(value, max_value, width, danger_zone, suffix=None)

Picture of a gauge

Draw a basic horizontal gauge to the screen.

Parameters

  • value
  • max_value
  • width
  • danger_zone
  • suffix

Example

from py_clui import gauge

total = 100
free = 30

used = total - free

print(gauge(used, total, 20, total * 0.8, 'Used memory'))

Progress(width=20)

Picture of a progress

Parameters

  • width - The width in characters of progress_bar

Methods

  • update(percent) - Return a progress bar width a this percente filled.

Example

from py_clui import Progress

progress = Progress(20)

print(progress.update(.5))

Motivation

  1. clui makes NodeJS even more sexy. Python needed something like it.

Project details


Release history Release notifications

This version
History Node

0.0.3

History Node

0.0.2

History Node

0.0.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
py_clui-0.0.3.tar.gz (3.0 kB) Copy SHA256 hash SHA256 Source None Apr 10, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page