__init__.py 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  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. # SPDX-License-Identifier: LGPL-2.1-or-later OR BSD-3-Clause-Clear
  8. #
  9. # 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. """Text progress bar library for Python.
  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. The ProgressBar class manages the current progress, and the format of the line
  26. is given by a number of widgets. A widget is an object that may display
  27. differently depending on the state of the progress bar. There are three types
  28. of widgets:
  29. - a string, which always shows itself
  30. - a ProgressBarWidget, which may return a different value every time its
  31. update method is called
  32. - a ProgressBarWidgetHFill, which is like ProgressBarWidget, except it
  33. expands to fill the remaining width of the line.
  34. The progressbar module is very easy to use, yet very powerful. It will also
  35. automatically enable features like auto-resizing when the system supports it.
  36. """
  37. __author__ = 'Nilton Volpato'
  38. __author_email__ = 'first-name dot last-name @ gmail.com'
  39. __date__ = '2011-05-14'
  40. __version__ = '2.3'
  41. from .compat import *
  42. from .widgets import *
  43. from .progressbar import *