Skip to content

Repository files navigation

Click Spinner

PyPI

Sometimes you would just like to show the user some progress, but a progress bar is not suitable because you don’t know how much longer it would take. In these cases you might want to display a simple spinner using the spinner() function.

Example usage:

with click_spinner.spinner():
        do_something()
        do_something_else()

It looks like this:

spinner

Spinner class based on on a gist by @cevaris.

Introduced in PR #649.

Install

pip install click-spinner

Supports Python 3.8+.

For Python <3.8, use v0.1.11.

Authors

  • @yoavram
  • @andy-maier
  • @AdrienPensart

Caveats

Printing (or writing) to stdout while a spinner is active will interleave with the spinner animation and look garbled. Prefer logging to stderr, or stop the spinner before printing. See issue #42.

About

It's easy to show that your command line app is active

Resources

Stars

296 stars

Watchers

3 watching

Forks

Releases

Used by

Contributors

Languages