Metadata-Version: 2.1
Name: tqdm-thread
Version: 0.1.1
Summary: TQDM context manager thread
Home-page: https://github.com/riklopfer/tqdm-thread
Author: Russell Klopfer
Author-email: russell.klopfer@gmail.com
License: MIT License
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: tqdm ; python_version >= "3.5"

tqdm-thread
===========
[![Python application](https://github.com/riklopfer/tqdm-thread/actions/workflows/python-app.yml/badge.svg)](https://github.com/riklopfer/tqdm-thread/actions/workflows/python-app.yml)

When you want to show that something is working, but don't have an iterable. For example, if you're loading a large
Pickle file and want to show progress. All kwargs work as expected with [tqdm](https://tqdm.github.io/docs/tqdm/#__init__) with a couple exceptions:

1. `step_sec` -- this is new. how many seconds to sleep between steps. default: `1.0`
1. `total` -- since we don't actually know the total, this create a new progress bar every `total` steps. default: `None`
1. default `bar_format` is different; if `total` then '{desc} {bar} {elapsed}' else '{desc} {elapsed}'

```python
import time
from tqdm_thread import tqdm_thread

with tqdm_thread(desc="doing serious work"):
    # no total; no pogress bar; just a counter
    time.sleep(10)

with tqdm_thread(desc="doing serious work", total=10):
    # adding 'total' means that you will get a bar
    time.sleep(10)

with tqdm_thread(desc="doing serious work", total=5):
    # here, two progress bars will be created
    time.sleep(10)


```


Tests
-----

```shell
# pip install pytest

pytest -vs .
```


