summaryrefslogtreecommitdiffstats
path: root/scripts/external_libs/progressbar-2.2/README
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/external_libs/progressbar-2.2/README')
-rwxr-xr-xscripts/external_libs/progressbar-2.2/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/scripts/external_libs/progressbar-2.2/README b/scripts/external_libs/progressbar-2.2/README
new file mode 100755
index 00000000..a5e861bf
--- /dev/null
+++ b/scripts/external_libs/progressbar-2.2/README
@@ -0,0 +1,18 @@
+Text progressbar library for python.
+
+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.
+
+The progressbar module is very easy to use, yet very powerful. And
+automatically supports features like auto-resizing when available.