Skip to main content

Build Nice User Interfaces In The Terminal

Project description

https://img.shields.io/pypi/pyversions/cli-ui.svg https://img.shields.io/pypi/v/cli-ui.svg https://img.shields.io/github/license/dmerejkowsky/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.

Note

This project was originally hosted on the TankerHQ organization, which was my employer from 2016 to 2021. They kindly agreed to give back ownership of this project to me. Thanks!

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli-ui-0.16.1.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.9.7 Linux/5.13.0-35-generic

File hashes

Hashes for cli-ui-0.16.1.tar.gz
Algorithm Hash digest
SHA256 97feef6664be4441a15430726c39f7c19a1f84c3bdea65c8ec70662fc57f7006
MD5 6471db44667664618f579ca71a00f9ba
BLAKE2b-256 bd61e86e71a620d5ceb260454c972676a5d274d2837866f6449c1e4a52fa3b84

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ui-0.16.1-py3-none-any.whl
  • Upload date:
  • Size: 12.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.9.7 Linux/5.13.0-35-generic

File hashes

Hashes for cli_ui-0.16.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d7c414cca3adcce75586b35826a3dbe828048cf8bdbe4cbdeb6794d43efcafa3
MD5 a932dec5b9cb8f0c22f6f37f3f2ed736
BLAKE2b-256 5ad4dc0818ccf45833a58a49abcf00d0cd26cfc42ef0ecb42c06662ff4ac8c98

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