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.9.0.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli-ui-0.9.0.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.0.tar.gz
Algorithm Hash digest
SHA256 9766d4c84ac5b261f1b1fdfa3c1d5a643f565902a0cea712246da0fb4dbe47e1
MD5 6d919853398990a9da3845e23ddd08e9
BLAKE2b-256 3adb5f47cefb68144a99b38fae60f10f07cc6f413dd77ed30037f48096408f18

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ui-0.9.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.8rc1

File hashes

Hashes for cli_ui-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5e673c3b5b123f59f33c2170652843db89e9ef1f759a121a00ab4609a9121063
MD5 bf2d29f8c1dfc79ad8679e050437e4bd
BLAKE2b-256 f9e208af219afd2bb1c5dfc7af6952b01ba99096d2dd826c1eed52363c02958a

See more details on using hashes here.

Supported by

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