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.

It also includes the following easy to use components:
* Spinners

### Spinner(message, style=None)

![Picture of a spinner](https://raw.githubusercontent.com/hmleal/py-clui/master/docs/spinner.gif)

__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__

```python
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()
```

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

Project details


Download files

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

Source Distribution

py_clui-0.0.2.tar.gz (2.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page