Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

Python Progress Indicator Utility

Project description

The PyPrind (Python Progress Indicator) module provides a progress bar
and a percentage indicator object that let you track the progress of a loop
structure or other iterative computation.
Typical applications include the processing of large data sets to provide
an intuitive estimate at runtime about the progress of the computation.





Examples
=============

The following examples shall illustrate the typical usage of the PyPrind package.
A visualization can be viewed on YouTube: [http://youtu.be/gjj5K8OWo7U](http://youtu.be/gjj5K8OWo7U)


Example - Progress Bar
--------------------------

<pre>import pypr<pre>sebastian > python3 ./examples/ex1_percentage_indicator.py
[ 12 %] elapsed: 2.095 sec | eta: 16.000 sec
</pre>
ind

n = 10000000
my_prbar = pyprind.ProgBar(n)
for i in range(n):
# do some computation
my_prbar.update()
</pre>

**Screen Output**

<pre>sebastian > python3 ./examples/ex1_progress_bar.py
0% 100%
[########################################]
Total time elapsed: 1.033 sec
</pre>


Example - Percentage Indicator
--------------------------

<pre>import pyprind

n = 1000000
my_perc = pyprind.ProgPercent(n)
for i in range(n):
# do some computation
my_perc.update()
</pre>

**Screen Output**

<pre>sebastian > python3 ./examples/ex1_percentage_indicator.py
[ 12 %] elapsed: 2.095 sec | eta: 16.000 sec
</pre>


#### Default Parameters

ProgBar(iterations, track_time=True, width=50, stream=2):

iterations (int): number of iterations of the computation
track_time (bool): prints elapsed time when loop has finished
stream: takes 1 for stdout, 2 for stderr, or given stream object


ProgPercent(iterations, track_time=True, stream=2):

iterations (int): number of iterations of the computation
width (int): width of the progress bar in characters
track_time (bool): prints elapsed time and estimated time left
stream: takes 1 for stdout, 2 for stderr, or given stream object


**VERSION 2.1.0**

- added ETA (estimated time until arrival) tracking by Taylan Aydinli

**VERSION 2.0.3**

- Accepts a given outputstream for the `stream` parameter.

**VERSION 2.0.0**

- ProgBar and ProgPerc inherit data members from parent class Prog
- Added ProgBar and ProgPerc default argument `stream=2` to write to stderr by
default. Set `stream=1` to write to stdout.

my_prbar = pyprind.ProgBar(n, stream=1) # writes to stdout
my_prbar = pyprind.ProgBar(n, stream=2) # writes to stderr, default


- Does not redirect data to the standard output or error stream if program is not
outputting to a terminal



Contact
=============

If you have any questions or comments about PyPrind, please feel free to contact me via
eMail: [se.raschka@gmail.com](mailto:se.raschka@gmail.com)
or Twitter: [@rasbt](https://twitter.com/rasbt)

Project details


Download files

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

Files for PyPrind, version 2.1.0
Filename, size File type Python version Upload date Hashes
Filename, size PyPrind-2.1.0.tar.gz (20.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page