skip to navigation
skip to content

Not Logged In

PyPrind 2.0.3

Python Progress Indicator Utility

Package Documentation

Latest Version: 2.5.0

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 pyprind

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
[100 %]   elapsed: 2.674 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
        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 when loop is finished
        stream: takes 1 for stdout, 2 for stderr, or given stream object



**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)
 
File Type Py Version Uploaded on Size
PyPrind-2.0.3.tar.gz (md5) Source 2014-02-05 19KB
  • Downloads (All Versions):
  • 130 downloads in the last day
  • 1832 downloads in the last week
  • 3122 downloads in the last month