aboutsummaryrefslogtreecommitdiffstats
path: root/misc/py-progressbar/pkg-descr
diff options
context:
space:
mode:
Diffstat (limited to 'misc/py-progressbar/pkg-descr')
-rw-r--r--misc/py-progressbar/pkg-descr19
1 files changed, 19 insertions, 0 deletions
diff --git a/misc/py-progressbar/pkg-descr b/misc/py-progressbar/pkg-descr
new file mode 100644
index 00000000000..c9c13f58601
--- /dev/null
+++ b/misc/py-progressbar/pkg-descr
@@ -0,0 +1,19 @@
+This library provides a text mode progressbar. This is tipically
+used to display the progress of a long running operation, providing
+a visual clue that processing is underway.
+
+The ProgressBar class manages the progress, and the format of the
+line is given by a number of widgets. A widget is an object that
+may display diferently depending on the state of the progress.
+
+There are three types of widget:
+
+- a string, which always shows itself;
+
+- a ProgressBarWidget, which may return a diferent value every time
+it's update method is called; and
+
+- a ProgressBarWidgetHFill, which is like ProgressBarWidget, except
+it expands to fill the remaining width of the line.
+
+WWW: http://pypi.python.org/pypi/progressbar/