Welcome to the Progress API

This package provides a backend-agnostic API for reporting progress, so that libraries can report progress information without being tied to specific progress bar libraries. It also provides several backend implementations, including tqdm and enlighten. New backends can be registered as entry points (see implementing-backends).

The progress API provides a good deal of flexibility; in particular, it allows multiple states that some backends may report with different colors or other distinguishing visuals (see Multiple States). Progress reports are also attached to Python loggers, for backends that may wish to report through the logging framework or use the logging configuration to determine which progress bars to display.

Documentation Sections