TQDM-style progress bar

Problem

The st.progress API is quite low level:

• it cannot be composed with iterators
• it doesn’t automatically compute percentages or time remaining

Solution

MVP

It would be great if we had another primitive that behaved like tqdm, with a similar (or identical?) API.

Possible additions

Should we make a special widget for this?

[Wirg]

I think you may be interested in stqdm :

• Github repo : https://github.com/Wirg/stqdm
• Pypi : https://pypi.org/project/stqdm/

This takes the best from tqdm & streamlit to :

• update only when necessary and avoid slowing down your program too much
• have a progress bar in your frontend and backend
• add a description and all the tqdm options
• add the tqdm details to your frontend (% completion, ETA …)

Upcoming features :

• better handling of multiple progress bars
• colors

[jeremyjordan]

The current progress widget, as you mentioned, feels too low level for everyday use. Here’s a minimum implementation that would capture the desirable level of abstraction. The nice thing about tqdm is you can simply wrap the object you’re iterating over and it will figure out how to report progress.

import streamlit as st
import time


class tqdm:
    def __init__(self, iterable, title=None):
        if title:
            st.write(title)
        self.prog_bar = st.progress(0)
        self.iterable = iterable
        self.length = len(iterable)
        self.i = 0

    def __iter__(self):
        for obj in self.iterable:
            yield obj
            self.i += 1
            current_prog = self.i / self.length
            self.prog_bar.progress(current_prog)


for i in tqdm(range(200), title='tqdm style progress bar'):
    time.sleep(0.05)

st.balloons()