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

Uploaded Source

Built Distribution

cli_ui-0.13.0-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli-ui-0.13.0.tar.gz
  • Upload date:
  • Size: 12.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.3 Linux/5.11.15-arch1-2

File hashes

Hashes for cli-ui-0.13.0.tar.gz
Algorithm Hash digest
SHA256 9d03466028a3d9738d0a8f7c734abbb83dc609b3d1e8115494e6ab86fe88cd0f
MD5 82ab601be32e999cb9e30efff1e6594a
BLAKE2b-256 886fdaf94fa870c8e71ae31a4dc1799b5be719316481b5cd5f66beba9585083d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cli_ui-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.3 Linux/5.11.15-arch1-2

File hashes

Hashes for cli_ui-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b0c910e5a8ae32d8d7690807ed57ed53b155d48739d87c8daa5f81245c85155
MD5 6b6b1fb156d18afc633d6876ea1e7db1
BLAKE2b-256 8bdf824291e044049e16300277e41813ecc326a3eb9a77d5ad8374d13601140d

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