Metadata-Version: 2.4
Name: emoji-progress-bar
Version: 0.0.2
Summary: Animated clock-emoji busy spinner for Slack messages
Author-email: Pierre Sassoulas <pierre.sassoulas@gmail.com>
Project-URL: Homepage, https://github.com/Pierre-Sassoulas/emoji-progress-bar
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: test
Requires-Dist: coverage; extra == "test"
Requires-Dist: coveralls; extra == "test"
Requires-Dist: pre-commit; extra == "test"
Requires-Dist: pylint; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: python-coveralls; extra == "test"
Dynamic: license-file

# emoji-progress-bar

Animated clock-emoji busy spinner for Slack messages.

`SlackBusySpinner` is an iterator that yields Slack clock-emoji names
(`clock1`, `clock130`, `clock2`, ... `clock1230`) in a loop. Update a Slack
message's emoji with each value to render a spinning clock while a long task
runs.

## Install

```bash
pip install emoji-progress-bar
```

## Usage

```python
from emoji_progress_bar import SlackBusySpinner

# Endless spinner: yields clock1, clock130, clock2, ... and loops.
for emoji in SlackBusySpinner():
    # e.g. update your Slack message with f":{emoji}:"
    ...

# Bounded spinner: StopIteration once the internal index passes `timeout`.
spinner = SlackBusySpinner(timeout=48)
emojis = list(spinner)
```
