philiprehberger-cli-spinner
v0.2.0650 downloadsMIT
Dead-simple terminal spinners and progress indicators for CLI scripts
$
pip install philiprehberger-cli-spinnerREADME
philiprehberger-cli-spinner
Dead-simple terminal spinners and progress indicators for CLI scripts.
Installation
pip install philiprehberger-cli-spinner
Usage
from philiprehberger_cli_spinner import spinner
with spinner("Loading data"):
do_work()
Finish with status
from philiprehberger_cli_spinner import spinner
s = spinner("Deploying")
s.start()
try:
deploy()
s.succeed("Deployed successfully")
except Exception:
s.fail("Deploy failed")
Decorator
from philiprehberger_cli_spinner import spin
@spin("Computing")
def heavy_task():
...
Update text
from philiprehberger_cli_spinner import spinner
with spinner("Step 1") as s:
step_one()
s.update("Step 2")
step_two()
Styles
Five built-in animation styles are available:
from philiprehberger_cli_spinner import spinner
with spinner("Working", style="braille"):
do_work()
Available styles: dots, line, bounce, braille, arrow.
API
| Function / Method | Description |
|---|---|
spinner(text, *, style) | Create a Spinner (context manager) |
spin(text, *, style) | Decorator that shows a spinner during execution |
Spinner.start() | Start the spinner animation |
Spinner.stop() | Stop the spinner and clear the line |
Spinner.update(text) | Change the displayed text |
Spinner.succeed(text) | Stop with a success symbol |
Spinner.fail(text) | Stop with a failure symbol |
Spinner.warn(text) | Stop with a warning symbol |
Spinner.info(text) | Stop with an info symbol |
Development
pip install -e .
python -m pytest tests/ -v
Support
If you find this project useful: