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

Uploaded Source

Built Distribution

cli_ui-0.15.2-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli-ui-0.15.2.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.7 Linux/5.14.8-arch1-1

File hashes

Hashes for cli-ui-0.15.2.tar.gz
Algorithm Hash digest
SHA256 5b58167504d8af43dc29eaa19a9b8cdcab84f47eb5555af9194d11366227a5de
MD5 2742fdeca23979a1075cf3e72ef18b39
BLAKE2b-256 f649cef3de0580d979877d0ab1bb45520568234628252298e6acf596ec402db1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ui-0.15.2-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.7 Linux/5.14.8-arch1-1

File hashes

Hashes for cli_ui-0.15.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ec5297d60f3f90580dc2747f165502f4993da7b5cb6826e2c1038c0039c73276
MD5 fb9ef2382830bce43b982db01701630c
BLAKE2b-256 29f04756424cd72cef74020819fa0c6aaf33ac97adab1d89d99a8f3f8c95a02e

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