stqdm

0.0.5 · active · verified Wed Apr 15

stqdm provides an easy-to-use progress bar for Streamlit applications, integrating the functionality of the popular `tqdm` library with Streamlit's `st.progress`. The current version is 0.0.5, released in January 2023, and the library is actively maintained for compatibility with newer Python, Streamlit, and tqdm versions, though with an irregular release cadence.

Warnings

gotcha Stopping a Streamlit app (e.g., via the 'Stop' button in the UI) while an `stqdm` loop is active can cause the app to freeze or the progress bar to become unresponsive on subsequent reruns. A full console restart is often required to recover.
Fix: As a workaround, you can explicitly set a lock for stqdm, especially when using `stqdm.pandas()`. Add `from threading import RLock; stqdm.set_lock(RLock())` at the top of your script. This helps prevent the app from entering an infinite loop.
deprecated In versions prior to 0.0.5, `stqdm` had issues with iterators that did not provide a predefined length or total, such as generators. The progress bar might not display correctly or update as expected.
Fix: Update to `stqdm` version 0.0.5 or newer, which properly provides time updates even for iterators without a length.
gotcha Using multiple `stqdm` instances in an application, particularly across reruns, might lead to issues where Streamlit fails to reload. This has been reported as an issue related to a `last_print_t` attribute.
Fix: Monitor GitHub issues for official fixes. Consider refactoring to use a single `stqdm` instance where possible, or explore alternative Streamlit native progress handling if encountering this specific issue until a resolution is provided.
gotcha There are reported limitations and 'weird interactions' when using `stqdm` in conjunction with multithreading within a Streamlit application. Direct `tqdm` (and by extension `stqdm`) updates from non-Streamlit threads might not propagate correctly.
Fix: Ensure that `stqdm` updates happen within the main Streamlit script context. If using background threads, you might need to manually manage `streamlit.scriptrunner.add_script_run_ctx` or similar context propagation, or consider alternative methods for updating the Streamlit UI from threads.

Install

pip install stqdm Install stqdm

Imports

stqdm
wrong:
```
from tqdm import tqdm
```
correct:
```
from stqdm import stqdm
```
While stqdm inherits from tqdm, directly importing tqdm.tqdm will not provide Streamlit integration.
stqdm.pandas
```
from stqdm import stqdm
stqdm.pandas()
```
Enables progress bars for pandas DataFrame and Series operations, similar to tqdm.pandas().

Quickstart

This example demonstrates how to use `stqdm` for a loop in the main Streamlit area and within the sidebar. Run this with `streamlit run your_script.py`.

import streamlit as st
import time
from stqdm import stqdm

st.title('stqdm Demo')

if st.button('Start Progress Bar'):
    for i in stqdm(range(50), desc="Processing items"):
        time.sleep(0.1)
    st.success("Processing complete!")

if st.button('Start Progress Bar in Sidebar'):
    with st.sidebar:
        for i in stqdm(range(20), desc="Sidebar progress"):
            time.sleep(0.2)
        st.success("Sidebar processing complete!")

view raw JSON →