## progress.track_progress()


Track progress by iterating over a sequence.


Usage

``` python
progress.track_progress(
    sequence,
    description="Working...",
    *,
    total=None,
    completed=0,
    update_period=0.1,
    show_progress=True,
    **progress_kwargs
)
```


Wraps `rich.progress.Progress.track` with the standard column layout from [create_progress](progress.create_progress.md#freezebase.progress.create_progress).


## Parameters


`sequence: Iterable[ProgressType]`  
The iterable to track progress over.

`description: str = ``"Working…"`  
Label displayed alongside the progress bar.

`total: float or None = None`  
Total number of steps. If None, the length of `sequence` is used when available.

`completed: int = ``0`  
Number of steps already completed at the start.

`update_period: float = ``0.1`  
Minimum time in seconds between progress bar updates.

`show_progress: bool = ``True`  
Whether to display the progress bar.

`**progress_kwargs: Any`  
Additional keyword arguments passed to `rich.progress.Progress`.


## Yields


`ProgressType`  
Items from `sequence`.