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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli-ui-0.15.1.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.9.6 Linux/5.13.10-arch1-1

File hashes

Hashes for cli-ui-0.15.1.tar.gz
Algorithm Hash digest
SHA256 2458ae37372727c682eada71d43cdf0c70a1e474f6a5f27a3a54301aca9434c4
MD5 39f9e8546d80daeb1678abb01ff5751d
BLAKE2b-256 61ef1ae29a2e3ca62fb38039b5be4d70959dcb6dbc147e49f4d59e2bcab75257

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cli_ui-0.15.1-py3-none-any.whl
Algorithm Hash digest
SHA256 839d06552a76216c5582bc0263753a5aed98e6e3129bd4a594a6c201d4161f95
MD5 a0d74ed17a16e71f8a0da7bd9e5717b2
BLAKE2b-256 79ea9f8d090060108d0fa2f9b65e0c393756f0714fdd98a6945cea42cb53021c

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