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

Uploaded Source

Built Distribution

cli_ui-0.14.1-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli-ui-0.14.1.tar.gz
  • Upload date:
  • Size: 12.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.5 Linux/5.12.9-arch1-1

File hashes

Hashes for cli-ui-0.14.1.tar.gz
Algorithm Hash digest
SHA256 52ec5b9bebcae86356053376c761a14ea5adb55d7bee071dad485766839a3428
MD5 fdcd8187770882a5e20fe7b441cd8a51
BLAKE2b-256 cb62d735a5a3ef3473436b8102ac6e8709f2c4898a16d8a568809c20e6aef909

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ui-0.14.1-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.5 Linux/5.12.9-arch1-1

File hashes

Hashes for cli_ui-0.14.1-py3-none-any.whl
Algorithm Hash digest
SHA256 52ca24d73516880e02a0289e52693b2fcf9c58317e046f9f092176978854c31b
MD5 57f79b95f17964fa6c3515a93d284abe
BLAKE2b-256 dfb9013464fb3c30b5a598af70854eb4c10416356c72473b71c6332e86be7c78

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