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