diff --git a/README.html b/README.html deleted file mode 100644 index 3904020..0000000 --- a/README.html +++ /dev/null @@ -1,504 +0,0 @@ - - - - - - -PyPrind (Python Progress Indicator) - - - -

PyPI version -Python 2.7 -Python 3.4 -Python 3.4

- -

PyPrind (Python Progress Indicator)

- -

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.

- -


- -

Progress Bars and Percentage Indicators

- -

Screenshot of PyPrind executed in an IPython notebook

- -


-

- -

- -

Advanced Tracking

- -

Screenshot of PyPrind executed in an IPython notebook

- -

Choose Your Favorite Bar Style

- -

Screenshot of PyPrind executed in an IPython notebook

- -

View more examples in an IPython Demo Notebook

- -


-

- -

- -

Sections

- -
- - -

- - -


-
-

- -

Installation

- -

[back to top]

- -

The most convenient way to install PyPrind is via tools like pip or easy_install:

- - - - -

PyPrind comes without any dependencies except for the optional psutil to monitor CPU and memory usages. You can install psutil via pip install pyprind or install it automatically with PyPrind:
- pip install pyprind -r requirements.txt

- -

Alternatively, you can install PyPrind the classic way: Download the package from the Python Package Index https://pypi.python.org/pypi/PyPrind, unzip it, navigate into the unzipped directory, and use the command

- -

python setup.py install

- -

- - -


-
-

- -

Documentation

- -

[back to top]

- -

PyPrind consists of two class objects that can visualize the progress of a computation on the output screen.
-Progress bars are available via ProgBar, and percentage indicators can be used via a ProgPercent.

- -
n = 10000000
-bar = pyprind.ProgBar(n)   # 1) initialization with number of iterations
-for i in range(n):  
-    # do some computation
-    bar.update()           # 2) update the progress visualization
-
- -

Alternatively, the progress can be tracked via the equivalent generator functions prog_bar and prog_percent:

- -
for i in pyprind.prog_bar(range(n)):
-    # do something
-    pass
-
- -


- -

Complete Parameter List for ProgBar Objects

- -
class ProgBar(Prog):
-    """ 
-    Initializes a progress bar object that allows visuzalization
-    of an iterational computation in the standard output screen. 
-
-    Parameters
-    ----------
-    iterations : `int`
-      Number of iterations for the iterative computation.
-
-    track_time : `bool` (default = `True`) 
-      Prints elapsed time when loop has finished.
-
-    width : `int` (default = 30)
-      Sets the progress bar width in characters.
-
-    stream : `int` (default = 2). 
-      Setting the output stream. 
-      Takes `1` for stdout, `2` for stderr, or a custom stream object
-
-    title : `str` (default = `''`). 
-      Setting a title for the progress bar.
-
-    monitor : `bool` (default = False)
-      Monitors CPU and memory usage if `True` (requires `psutil` package).  
-
-    """
-
- -


- -

Complete Parameter List for ProgPercent Objects

- -
class ProgPercent(Prog):    
-    """ 
-    Initializes a progress bar object that allows visuzalization
-    of an iterational computation in the standard output screen. 
-
-    Parameters
-    ----------
-    iterations : `int`
-      Number of iterations for the iterative computation.
-
-    track_time : `bool` (default = `True`) 
-      Prints elapsed time when loop has finished.
-
-    stream : `int` (default = 2). 
-      Setting the output stream. 
-      Takes `1` for stdout, `2` for stderr, or a custom stream object
-
-    title : `str` (default = `''`). 
-      Setting a title for the percentage indicator.
-
-    monitor : `bool` (default = False)
-      Monitors CPU and memory usage if `True` (requires `psutil` package).  
-
-    """
-
- -

- - -


-
-

- -

Examples

- -

[back to top]

- -

Examples for using the progress bar and percentage indicator objects can be found in the IPython Demo Notebook.

- -

- - -


-
-

- -

Contact

- -

[back to top]

- -

If you have any questions or comments about PyPrind, please feel free to contact me via
-eMail: se.raschka@gmail.com
-or Twitter: @rasbt

- -

The pyprind module is available on GitHub at https://github.com/rasbt/pyprind.

- - \ No newline at end of file diff --git a/README.md b/README.md index d731533..a02f07b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ [![License](https://img.shields.io/badge/license-new%20BSD-blue.svg)](https://github.com/rasbt/pyprind/blob/master/LICENSE.txt) ![Python 2.7](https://img.shields.io/badge/python-2.7-blue.svg) ![Python 3.4](https://img.shields.io/badge/python-3.4-blue.svg) -![Python 3.4](https://img.shields.io/badge/license-GPLv3-blue.svg) # PyPrind (Python Progress Indicator) diff --git a/setup.py b/setup.py index 6e56712..45104ae 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,8 @@ url='https://github.com/rasbt/pyprind', packages=['pyprind'], data_files=[('', ['LICENSE']), - ('', ['README.html']), + ('', ['README.md']), + ('', ['CONTRIBUTING.md']), ('', ['CHANGELOG.md']), ('examples', ['examples/ex1_percentage_indicator_stderr.py']), ('examples', ['examples/ex1_percentage_indicator_stdout.py']),