Skip to main content

Build Nice User Interfaces In The Terminal

Project description

https://tanker.io/images/github-logo.png

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 https://img.shields.io/badge/deps%20scanning-pyup.io-green

python-cli-ui

Tools for nice user interfaces in the terminal.

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.11.0.tar.gz (11.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.11.0-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli-ui-0.11.0.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.7.1 Linux/5.7.0-1-amd64

File hashes

Hashes for cli-ui-0.11.0.tar.gz
Algorithm Hash digest
SHA256 f73b5ca388404829e8a3f537f0fc85be6bf20979ac18356fc520d989c0ccd230
MD5 1c815f64896b92bdfce9682d97aaed30
BLAKE2b-256 331409fa43aa284b4d052044b585429d5fcc80ae7d692ec210ebe6131892a271

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ui-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 12.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.7.1 Linux/5.7.0-1-amd64

File hashes

Hashes for cli_ui-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7998d6f6e116184935c554d18250861d3001156ea356bbd8008c488fc226ac6c
MD5 e9262eb8293a1c756a1df4996de41157
BLAKE2b-256 f6c524fdcfa46330a622ab179abb3f58b15b63c7b4e4e9bb68880ceff6d2e1aa

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