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/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.8.0.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli-ui-0.8.0.tar.gz
  • Upload date:
  • Size: 10.6 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.7

File hashes

Hashes for cli-ui-0.8.0.tar.gz
Algorithm Hash digest
SHA256 1d735e891b667acf1759bafdcb3d28c5d294604129018ccde5401b2defeb7596
MD5 49c5dfc0bcd2a1dd1041c5798de15da2
BLAKE2b-256 6d07d5aae0e71df1a272aedd87142f716549e1c3acfd676561c251ce8e728e48

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ui-0.8.0-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.7

File hashes

Hashes for cli_ui-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3978dcb4d5da728935d976c72cebac86fe552acce2534c4789428aea7a595f9f
MD5 12357743899db7cf28739284a7aefc31
BLAKE2b-256 a5446cdda0d551009420662ccdb0727ff14ce1f24bc861b918551f47c076ab8a

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