progressbar2

A Python Progressbar library to provide visual (yet text based) progress to long running operations.

These details have not been verified by PyPI

Project links

Homepage

Project description

##############################################################################
Text progress bar library for Python.
##############################################################################

Travis status:

.. image:: https://travis-ci.org/WoLpH/python-progressbar.png?branch=master
:target: https://travis-ci.org/WoLpH/python-progressbar

Coverage:

.. image:: https://coveralls.io/repos/WoLpH/python-progressbar/badge.png?branch=master
:target: https://coveralls.io/r/WoLpH/python-progressbar?branch=master

******************************************************************************
Introduction
******************************************************************************

.. highlights::

**NOTE:** This version has been completely rewritten and might not be
100% compatible with the old version. If you encounter any problems
while using it please let me know:
https://github.com/WoLpH/python-progressbar/issues

A text progress bar is typically used to display the progress of a long
running operation, providing a visual cue that processing is underway.

The ProgressBar class manages the current progress, and the format of the line
is given by a number of widgets. A widget is an object that may display
differently depending on the state of the progress bar. There are many types
of widgets:

- `Timer`
- `ETA`
- `AdaptiveETA`
- `FileTransferSpeed`
- `AdaptiveTransferSpeed`
- `AnimatedMarker`
- `Counter`
- `Percentage`
- `FormatLabel`
- `SimpleProgress`
- `Bar`
- `ReverseBar`
- `BouncingBar`
- `RotatingMarker`
- `DynamicMessage`

The progressbar module is very easy to use, yet very powerful. It will also
automatically enable features like auto-resizing when the system supports it.

******************************************************************************
Links
******************************************************************************

* Documentation
- http://progressbar-2.readthedocs.org/en/latest/
* Source
- https://github.com/WoLpH/python-progressbar
* Bug reports
- https://github.com/WoLpH/python-progressbar/issues
* Package homepage
- https://pypi-hypernode.com/pypi/progressbar2
* My blog
- http://w.wol.ph/

******************************************************************************
Usage
******************************************************************************

There are many ways to use Python Progressbar, you can see a few basic examples
here but there are many more in the :doc:`examples` file.

Wrapping an iterable
==============================================================================
::

import time
import progressbar

bar = progressbar.ProgressBar()
for i in bar(range(100)):
time.sleep(0.02)

Context wrapper
==============================================================================
::

import time
import progressbar

with progressbar.ProgressBar(max_value=10) as bar:
for i in range(10):
time.sleep(0.1)
bar.update(i)

Combining progressbars with print output
==============================================================================
::

import time
import progressbar

bar = progressbar.ProgressBar(redirect_stdout=True)
for i in range(100):
print 'Some text', i
time.sleep(0.1)
bar.update(i)

Progressbar with unknown length
==============================================================================
::

import time
import progressbar

bar = progressbar.ProgressBar(max_value=progressbar.UnknownLength)
for i in range(20):
time.sleep(0.1)
bar.update(i)

Bar with custom widgets
==============================================================================
::

import time
import progressbar

bar = progressbar.ProgressBar(widgets=[
' [', progressbar.Timer(), '] ',
progressbar.Bar(),
' (', progressbar.ETA(), ') ',
])
for i in bar(range(20)):
time.sleep(0.1)

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

4.5.0

Aug 28, 2024

4.4.3 yanked

Aug 23, 2024

Reason this release was yanked:

SyntaxError: invalid syntax

4.4.2

Mar 5, 2024

4.4.1

Feb 25, 2024

4.4.0

Feb 25, 2024

4.3.2

Dec 18, 2023

4.3.1

Dec 18, 2023

4.3.0

Dec 18, 2023

4.3b0 pre-release

Nov 1, 2022

4.2.0

Oct 26, 2022

4.1.1

Oct 18, 2022

4.1.0

Oct 18, 2022

4.0.0

Jan 5, 2022

3.55.0

Oct 15, 2021

3.54.0

Oct 12, 2021

3.53.3

Sep 14, 2021

3.53.2

Sep 9, 2021

3.53.1

Sep 9, 2020

3.53.0

Sep 9, 2020

3.52.1

Aug 29, 2020

3.51.4

Jun 25, 2020

3.51.3

May 2, 2020

3.51.2

May 1, 2020

3.51.1

Apr 29, 2020

3.51.0

Apr 20, 2020

3.50.1

Mar 20, 2020

3.50.0

Mar 3, 2020

3.47.0

Sep 30, 2019

3.46.1

Sep 19, 2019

3.46.0

Sep 18, 2019

3.45.1

Sep 19, 2019

3.43.1

Aug 21, 2019

3.42.0

May 31, 2019

3.41.0

May 29, 2019

3.39.3

Mar 13, 2019

3.39.2

Dec 17, 2018

3.39.0

Dec 16, 2018

3.38.0

May 26, 2018

3.37.1

Apr 12, 2018

3.37.0

Apr 6, 2018

3.36.0

Mar 4, 2018

3.35.2

Feb 14, 2018

3.35.1

Feb 13, 2018

3.35.0

Feb 12, 2018

3.34.3

Sep 21, 2017

3.34.2

Aug 5, 2017

3.34.0

Aug 3, 2017

3.33.2

Jul 29, 2017

3.33.1

Jul 29, 2017

3.33.0

Jul 28, 2017

3.32.1

Jul 24, 2017

3.32.0

Jul 23, 2017

3.31.1

Jul 23, 2017

3.30.2

Jun 2, 2017

3.30.0

May 30, 2017

3.20.2

May 26, 2017

3.20.1

May 25, 2017

3.20.0

May 5, 2017

3.18.1

Apr 14, 2017

3.18.0

Apr 8, 2017

3.17.1

Apr 4, 2017

3.17.0

Apr 3, 2017

3.16.1

Mar 30, 2017

3.16.0

Mar 17, 2017

3.15.1

Mar 17, 2017

3.15.0

Mar 15, 2017

3.12.0

Dec 21, 2016

3.11.0

Nov 13, 2016

3.10.1

Sep 10, 2016

3.10.0

Jul 16, 2016

3.9.4

Jul 3, 2016

3.9.3

Jun 26, 2016

3.9.2

Jun 26, 2016

This version

3.9.1

Jun 24, 2016

3.9.0

Jun 23, 2016

3.8.1

Jun 25, 2016

3.8.0

Jun 18, 2016

3.7.0

Jun 11, 2016

3.6.2

Mar 2, 2016

3.6.1

Feb 29, 2016

3.6.0

Dec 23, 2015

3.5.2

Dec 19, 2015

3.5.1

Nov 30, 2015

3.5.0

Nov 15, 2015

3.4.3

Nov 15, 2015

3.4.2

Nov 15, 2015

3.4.1

Nov 11, 2015

3.4.0

Nov 11, 2015

3.3.3

Nov 11, 2015

3.3.2

Nov 10, 2015

3.3.1

Nov 5, 2015

3.3.0

Oct 12, 2015

3.2.0

Oct 11, 2015

3.1.0

Oct 10, 2015

3.0.1

Oct 7, 2015

2.7.3

Nov 28, 2014

2.7.0

Nov 25, 2014

2.6.9

Nov 19, 2014

2.6.8

Nov 17, 2014

2.6.7

Sep 3, 2014

2.6.6

Sep 3, 2014

2.6.5

Sep 3, 2014

2.6.4

Sep 2, 2014

2.6.3

Sep 2, 2014

2.6.2

Jun 3, 2014

2.6.1

May 12, 2014

2.6.0

Sep 23, 2013

2.5.0

Sep 23, 2013

2.4.1

Aug 20, 2013

2.4.0

Aug 20, 2013

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

progressbar2-3.9.1.tar.gz (23.8 kB view details)

Uploaded Jun 24, 2016 Source

Built Distribution

progressbar2-3.9.1-py2.py3-none-any.whl (20.5 kB view details)

Uploaded Jun 24, 2016 Python 2 Python 3

File details

Details for the file progressbar2-3.9.1.tar.gz.

File metadata

Download URL: progressbar2-3.9.1.tar.gz
Upload date: Jun 24, 2016
Size: 23.8 kB
Tags: Source
Uploaded using Trusted Publishing? No

File hashes

Hashes for progressbar2-3.9.1.tar.gz
Algorithm	Hash digest
SHA256	`2b2c3cae4a96f0d6f438e58d53be80a2441075e3928914017971bed6fbab5e28`
MD5	`e0764d5651d79c4ab387a21a43162a52`
BLAKE2b-256	`a38fd7cd2e40758f7f75e78de466e0dca14026b4228ba3c1c0de61a103c42bff`

See more details on using hashes here.

File details

Details for the file progressbar2-3.9.1-py2.py3-none-any.whl.

File metadata

Download URL: progressbar2-3.9.1-py2.py3-none-any.whl
Upload date: Jun 24, 2016
Size: 20.5 kB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? No

File hashes

Hashes for progressbar2-3.9.1-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`5ddca008cc5c0d690e6c9d6e11441d0c9ee6c8f86b25b9145421621ebb32fcd3`
MD5	`6fa7c8941f7b35690083e68a58b3cc96`
BLAKE2b-256	`b435afb4763695524325db4733f17a010e94914ef8d874bc301305af866c5a76`