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
Demo
Watch the asciinema recording.
Usage
$ pip install cli-uiExample:
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!Contributing
We use optimistic merging so you don’t have to worry too much about formatting the code, pleasing the linters or making sure all the test pass.
That being said, if you want, you can install just and use it to check your changes automatically. Just run just to see available tasks.
Making a new release
Uploading documentation
Run:
just deploy-doc2 maintainers
Release files for cli-ui 0.19.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cli_ui-0.19.0.tar.gz | 12.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cli_ui-0.19.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 26.3 kB
Release files / cli_ui-0.19.0.tar.gz
| Download URL | cli_ui-0.19.0.tar.gz |
|---|---|
| Size | 12.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
59cdab0c6a2a6703c61b31cb75a1943076888907f015fffe15c5a8eb41a933aa
|
|
BLAKE2b-256 checksum How to use checksums |
216370d8fefa7b4140367c45287b94fb5df535b6ba6f77464087b18fdae2bb47
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.2
|
Release files / cli_ui-0.19.0-py3-none-any.whl
| Download URL | cli_ui-0.19.0-py3-none-any.whl |
|---|---|
| Size | 13.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1cf1b93328f7377730db29507e10bcb29ccc1427ceef45714b522d1f2055e7cd
|
|
BLAKE2b-256 checksum How to use checksums |
c6a909591cff626f71bd11f88d8eedb81619c17422b4a5e778614a91e83c4b6a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.2
|
