https://github.com/click-contrib/click-spinner

It's easy to show that your command line app is active
https://github.com/click-contrib/click-spinner

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/click-contrib/click-spinner
• Owner: click-contrib
• License: mit
• Created: 2016-09-04T10:30:57.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-08-25T20:05:54.000Z (almost 2 years ago)
• Last Synced: 2025-03-16T05:48:19.245Z (4 months ago)
• Language: Python
• Homepage:
• Size: 47.9 KB
• Stars: 298
• Watchers: 3
• Forks: 33
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ccamel - click-contrib/click-spinner - It's easy to show that your command line app is active (Python)

README

        
# Click Spinner

[![PyPI](https://img.shields.io/pypi/v/click-spinner.svg)](https://pypi.python.org/pypi/click-spinner/) [![Build Status](https://travis-ci.org/click-contrib/click-spinner.svg?branch=master)](https://travis-ci.org/click-contrib/click-spinner)

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:

```py

with click_spinner.spinner():

        do_something()

        do_something_else()

```

It looks like this:

![spinner](https://cloud.githubusercontent.com/assets/1288133/18229827/29629cd4-728f-11e6-8007-6c85ac50565c.gif)

Spinner class based on on a [gist by @cevaris](https://gist.github.com/cevaris/79700649f0543584009e).

Introduced in [PR #649](https://github.com/pallets/click/pull/649). 

## Install

```

pip install click-spinner

```

Supports Python 2.7 and 3.

## Authors

- @yoavram

- @andy-maier

- @AdrienPensart