https://github.com/wirg/stqdm

stqdm is the simplest way to handle a progress bar in streamlit app.
https://github.com/wirg/stqdm

eta progress progressbar progressmeter streamlit tqdm

Last synced: 6 days ago
JSON representation

stqdm is the simplest way to handle a progress bar in streamlit app.

• Host: GitHub
• URL: https://github.com/wirg/stqdm
• Owner: Wirg
• License: apache-2.0
• Created: 2020-11-29T11:29:36.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-23T19:25:26.000Z (8 months ago)
• Last Synced: 2024-12-25T02:03:33.902Z (6 days ago)
• Topics: eta, progress, progressbar, progressmeter, streamlit, tqdm
• Language: Python
• Homepage: https://github.com/Wirg/stqdm
• Size: 612 KB
• Stars: 252
• Watchers: 2
• Forks: 5
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# stqdm

![Tests](https://github.com/Wirg/stqdm/workflows/Tests/badge.svg)

[![codecov](https://codecov.io/gh/Wirg/stqdm/branch/main/graph/badge.svg?token=YeHnzpfMty)](https://codecov.io/gh/Wirg/stqdm)

[![CodeQL](https://github.com/Wirg/stqdm/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/Wirg/stqdm/actions/workflows/codeql-analysis.yml)

[![Downloads](https://static.pepy.tech/personalized-badge/stqdm?period=month&units=international_system&left_color=grey&right_color=brightgreen&left_text=downloads/month)](https://pepy.tech/project/stqdm)

![Supported Python Versions](https://img.shields.io/pypi/pyversions/stqdm)

![pypi version](https://img.shields.io/pypi/v/stqdm)

stqdm is the simplest way to handle a progress bar in streamlit app.

![demo gif](https://raw.githubusercontent.com/Wirg/stqdm/main/assets/demo.gif)

## How to install

```sh

pip install stqdm

```

## How to use

You can find some examples in `examples/`

### Use stqdm in main

```python

from time import sleep

from stqdm import stqdm

for _ in stqdm(range(50)):

    sleep(0.5)

```

### Use stqdm in sidebar

```python

from time import sleep

import streamlit as st

from stqdm import stqdm

for _ in stqdm(range(50), st_container=st.sidebar):

    sleep(0.5)

```

### Customize the bar with tqdm parameters

![demo gif](https://raw.githubusercontent.com/Wirg/stqdm/main/assets/demo_with_custom_params.gif)

```python

from time import sleep

from stqdm import stqdm

for _ in stqdm(range(50), desc="This is a slow task", mininterval=1):

    sleep(0.5)

```

### Display a progress bar during pandas Dataframe & Series operations

STqdm inherits from tqdm, you can call stqdm.pandas() in a similar way. See [tqdm docs](https://github.com/tqdm/tqdm#pandas-integration).

```python

from time import sleep

import pandas as pd

from stqdm import stqdm

stqdm.pandas()

pd.Series(range(50)).progress_map(lambda x: sleep(1))

pd.Dataframe({"a": range(50)}).progress_apply(lambda x: sleep(1), axis=1)

```

### Display the progress bar only in the frontend or the backend

```python

from time import sleep

from stqdm import stqdm

# Default to frontend only

for i in stqdm(range(50), backend=False, frontend=True):

    sleep(0.5)

for i in stqdm(range(50), backend=True, frontend=False):

    sleep(0.5)

```