Progress

1.6.1 · active · verified Sat Apr 11

The `progress` library (current version 1.6.1) provides easy-to-use, text-based progress bars and spinners for command-line interfaces. It offers a straightforward API with several built-in styles and aims for minimalism and speed, without external dependencies.

Warnings

gotcha The `progress` library does not support Jupyter notebooks or similar interactive environments, as it is primarily designed for terminal-based applications.
Fix: For Jupyter notebook support, consider alternatives like `tqdm` or `ipywidgets`.
gotcha Progress bars created with `progress` do not dynamically resize if the terminal window changes size during execution.
Fix: Ensure the terminal window size is stable, or use libraries with dynamic resizing support if this is a critical requirement.
gotcha This library (PyPI: `progress`) is often confused with `progressbar2` (PyPI: `progressbar2`). Ensure you install `progress` if you intend to use this specific library.
Fix: Verify your `pip install` command is `pip install progress` and your imports are from `progress.bar` or `progress.spinner`.
gotcha The `progress` library offers fewer customization options compared to more feature-rich progress bar libraries like `tqdm` or `progressbar2`.
Fix: Evaluate your customization needs; for advanced features or highly custom displays, explore `tqdm` or `progressbar2`.

Install

pip install progress Install stable version

Imports

Bar
```
from progress.bar import Bar
```
ChargingBar
```
from progress.bar import ChargingBar
```
IncrementalBar
```
from progress.bar import IncrementalBar
```
Spinner
```
from progress.spinner import Spinner
```

Quickstart

This quickstart demonstrates creating a basic progress bar using `progress.bar.Bar`. The `with` statement ensures the bar is properly finalized even if an error occurs. Call `bar.next()` in each iteration to advance the progress.

import time
from progress.bar import Bar

# Example with a simple Bar
with Bar('Processing...') as bar:
    for i in range(100):
        # Simulate work
        time.sleep(0.02)
        bar.next()

view raw JSON →