From a5981103cf85a6aac5d0df21f057959002ee32b5 Mon Sep 17 00:00:00 2001 From: Giorgos Verigakis Date: Thu, 28 Nov 2013 13:49:12 +0800 Subject: [PATCH] Update documentation --- README.rst | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index a330f9c..79a8eff 100644 --- a/README.rst +++ b/README.rst @@ -44,17 +44,20 @@ This will produce a bar like the following: :: You can use a number of template arguments in ``message`` and ``suffix``: -========= ============================= -Name Value -========= ============================= -index current value -max maximum value -remaining max - index -progress index / max -percent progress * 100 -avg rolling average time per item (in seconds) -eta avg * remaining -========= ============================= +========== ================================ +Name Value +========== ================================ +index current value +max maximum value +remaining max - index +progress index / max +percent progress * 100 +avg simple moving average time per item (in seconds) +elapsed elapsed time in seconds +elapsed_td elapsed as a timedelta (useful for printing as a string) +eta avg * remaining +eta_td eta as a timedelta (useful for printing as a string) +========== ================================ Instead of passing all configuration options on instatiation, you can create your custom subclass. :: @@ -64,6 +67,14 @@ your custom subclass. :: fill = '*' suffix = '%(percent).1f%% - %(eta)ds' +You can also override any of the arguments or create your own. :: + + class SlowBar(Bar): + suffix = '%(remaining_hours)d hours remaining' + @property + def remaining_hours(self): + return self.eta // 3600 + Spinners ========