Metadata-Version: 2.1
Name: loading_display
Version: 0.2.0
Summary: Simple loading bar and spinner for the terminal.
Project-URL: Homepage, https://bcde.xyz
Project-URL: Bug Tracker, https://gitlab.com/jarlv/py_packages/-/issues
Project-URL: gitlab.com, https://gitlab.com/jarlv/py_packages
Author-email: "Jarl V. Bjørgan" <jvbjorgan@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# Loading Display

[![Downloads](https://static.pepy.tech/personalized-badge/loading-display?period=total&units=international_system&left_color=black&right_color=blue&left_text=Downloads)](https://pepy.tech/project/loading-display)

Simple loading bar and spinner for the terminal.

## spinner

Prints unicode frames for a spinning animation.

The icons used as frames in the spinner can be changed using the `icons` parameter:

```py
>>> from loading_display import spinner
>>> s = spinner(icons=['🌑', '🌒', '🌓', '🌔', '🌕', '🌖', '🌗', '🌘'])
>>> while 1:
...     next(s)
```

## Loading bar

Prints a progress bar.

Usage:

```py
from loading_display import loading_bar

while loading:
    loading_bar(current_progress, 
                total=total_size, 
                bar_length=10, 
                show_percentage=True)
```

Default appearance:

```txt
████████████████████ 100.0 %
```

The appearance can be customized with the `icon` parameter.
