Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 1 | #!/usr/bin/python |
| 2 | # -*- coding: utf-8 -*- |
| 3 | # |
| 4 | # progressbar - Text progress bar library for Python. |
| 5 | # Copyright (c) 2005 Nilton Volpato |
| 6 | # |
| 7 | # This library is free software; you can redistribute it and/or |
| 8 | # modify it under the terms of the GNU Lesser General Public |
| 9 | # License as published by the Free Software Foundation; either |
| 10 | # version 2.1 of the License, or (at your option) any later version. |
| 11 | # |
| 12 | # This library is distributed in the hope that it will be useful, |
| 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15 | # Lesser General Public License for more details. |
| 16 | # |
| 17 | # You should have received a copy of the GNU Lesser General Public |
| 18 | # License along with this library; if not, write to the Free Software |
| 19 | # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 20 | |
| 21 | """Text progress bar library for Python. |
| 22 | |
| 23 | A text progress bar is typically used to display the progress of a long |
| 24 | running operation, providing a visual cue that processing is underway. |
| 25 | |
| 26 | The ProgressBar class manages the current progress, and the format of the line |
| 27 | is given by a number of widgets. A widget is an object that may display |
| 28 | differently depending on the state of the progress bar. There are three types |
| 29 | of widgets: |
| 30 | - a string, which always shows itself |
| 31 | |
| 32 | - a ProgressBarWidget, which may return a different value every time its |
| 33 | update method is called |
| 34 | |
| 35 | - a ProgressBarWidgetHFill, which is like ProgressBarWidget, except it |
| 36 | expands to fill the remaining width of the line. |
| 37 | |
| 38 | The progressbar module is very easy to use, yet very powerful. It will also |
| 39 | automatically enable features like auto-resizing when the system supports it. |
| 40 | """ |
| 41 | |
| 42 | __author__ = 'Nilton Volpato' |
| 43 | __author_email__ = 'first-name dot last-name @ gmail.com' |
| 44 | __date__ = '2011-05-14' |
| 45 | __version__ = '2.3' |
| 46 | |
| 47 | from .compat import * |
| 48 | from .widgets import * |
| 49 | from .progressbar import * |