PyProgressTerm (version 0.0.1)
index
pyprogressterm.py

This package implement customizable progress bar and rotating animations.

 
Modules
       
asyncio
os
sys

 
Classes
       
builtins.object
Progress

 
class Progress(builtins.object)
    This class implement customizable progress bar and rotating animations.
 
  Methods defined here:
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
async async_infinity_run(self, function_name: str = 'progress_bar', total: int = 100, wait: int = 0.05, **kwargs) -> None
This function implement an infinity progress bar (for asynchronous).
colored_progress_bar(self, *args, foreground: str = 'default', background: str = 'default', function_name: str = 'progress_bar', first_delimiter: str = '|', last_delimiter: str = '|', **kwargs) -> None
This function implement a colored progress bar.
 
Colors must be black, red, green, yellow, blue,
magenta, cyan gray or default.
progress_bar(self, step: int, progress_length: int = 50, line_length: int = 10, text: str = '', empty_char: str = ' ', progress_char: str = '█', first_delimiter: str = '|', last_delimiter: str = '|', total: int = 100, placeholder: str = '...') -> None
This function implement a customizable progress bar.
 
progress_char and empty_char must be a character.
 
text is a short description of the step.
 
line_length is the max text length.
rotating_animation(self, step: int, line_length: int = 10, title: str = 'Progress...', text: str = '', total: int = 100, placeholder: str = '...') -> None
This function implement a rotating animation.
rotating_progress_bar(self, step: int, *args, function_name: str = 'progress_bar', **kwargs) -> None
This function implement a rotating animation in the progress bar.
thread_infinity_run(self, function_name: str = 'progress_bar', total: int = 100, wait: int = 0.05, **kwargs) -> None
This function implement an infinity progress bar (for thread).
timed_progress_bar(self, *args, function_name: str = 'progress_bar', first_delimiter: str = '|', **kwargs) -> None
This function implement a timed probress bar.

Static methods defined here:
get_rotation(step: int) -> str
This function return the character for rotating animations.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Data and other attributes defined here:
rotating_characters = [r'\', '-', '/', '|']
rotating_characters_length = 4

 
Data
        __all__ = ['Progress']
__author_email__ = 'mauricelambert434@gmail.com'
__copyright__ = '\nPyProgressTerm Copyright (C) 2021 Maurice Lam...ome to redistribute it\nunder certain conditions.\n'
__description__ = 'This package implement customizable progress bar and rotating animations.'
__license__ = 'GPL-3.0 License'
__maintainer__ = 'Maurice Lambert'
__maintainer_email__ = 'mauricelambert434@gmail.com'
__url__ = 'https://github.com/mauricelambert/PyProgressTerm'

 
Author
        Maurice Lambert