Skip to main content

Build Nice User Interfaces In The Terminal

Project description

Tools for nice user interfaces in the terminal.

https://img.shields.io/travis/TankerHQ/python-cli-ui.svg?branch=master https://img.shields.io/pypi/pyversions/cli-ui.svg https://img.shields.io/pypi/v/cli-ui.svg https://img.shields.io/github/license/TankerHQ/python-cli-ui.svg

Documentation

See python-cli-ui documentation.

Demo

Watch the asciinema recording.

Usage

$ pip install cli-ui

Example:

import cli_ui

# coloring:
cli_ui.info(
  "This is",
  cli_ui.red, "red", cli_ui.reset,
  "and this is",
  cli_ui.bold, "bold"
)

# enumerating:
list_of_things = ["foo", "bar", "baz"]
for i, thing in enumerate(list_of_things):
    cli_ui.info_count(i, len(list_of_things), thing)

# progress indication:
cli_ui.info_progress("Done",  5, 20)
cli_ui.info_progress("Done", 10, 20)
cli_ui.info_progress("Done", 20, 20)

# reading user input:
with_sugar = cli_ui.ask_yes_no("With sugar?", default=False)

fruits = ["apple", "orange", "banana"]
selected_fruit = cli_ui.ask_choice("Choose a fruit", choices=fruits)

#  ... and more!

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

cli-ui-0.9.1.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

cli_ui-0.9.1-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file cli-ui-0.9.1.tar.gz.

File metadata

  • Download URL: cli-ui-0.9.1.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.8rc1

File hashes

Hashes for cli-ui-0.9.1.tar.gz
Algorithm Hash digest
SHA256 a92a89da63c89bdb9969b1d8d826723d09b6f7d98874450f9645911ba9a8ab52
MD5 fcb8a6243bb7bb72e3a186bfeb0b35f9
BLAKE2b-256 308084a7184cbdb5473abb102d6bd4395af9f1260e5f6c558d45e68e2c92752d

See more details on using hashes here.

File details

Details for the file cli_ui-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: cli_ui-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 12.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.8rc1

File hashes

Hashes for cli_ui-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fb6e183e2c6597a16da4380df334102e5e483c56f1525aad9f36dc12b22b1949
MD5 221607b78d724abab09cf526dd4f23a0
BLAKE2b-256 3774051dfaa17fd87ca0e5e7ab08f6c675afd5c707d8d92c40db59573ac99914

See more details on using hashes here.

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