0.2.0 runtime attributes

Author: jenca-adam

README.rst

@@ -215,5 +215,14 @@ RGB tuples must be in format 0-255 and must not contain alpha part.
 RGB tuples are only supported in Truecolor terminals.
 They might display differently/incorrectly in other terminals.
 
+Runtime attributes
+==================
+
+While your bar is running, you can easily access some of its attributes:
+
+- ``ProgressBar.eta`` - current ETA in seconds 
+- ``ProgressBar.percentage`` - current percentage
+- ``ProgressBar.items_done`` - number of items already done
+
 
 .. |spinner-line| image:: line-spinner.gif

build/build/lib/fancybar/progressbar.py

@@ -79,7 +79,7 @@ def parse_hex(h):
             (scol & 0xFF00) >> 8,
             (scol & 0xFF),
             (col & 0xFF) / 255,
-            )
+        )
     elif l == 3:  # short form, no alpha
         return 17 * ((col & 0xF00) >> 8), 17 * ((col & 0xF0) >> 4), 17 * (col & 0xF)
     elif l == 4:  # short form, alpha
@@ -111,7 +111,7 @@ def _color_range(start_r, start_g, start_b, end_r, end_g, end_b, length):
 
 def _generate_gradient_colors(startcol, endcol, length):
     col_r = _color_range(*startcol, *endcol, length)
-    cur=startcol
+    cur = startcol
     prev = 0, 0, 0
     i = 0
     curr_frame = ""
@@ -124,11 +124,11 @@ def _generate_gradient_colors(startcol, endcol, length):
         if i % 2 == 1:
             nxt = cur
             cur = prev
-            prev_frame = curr_frame = prev_frame + GRADIENT_TEMPLATE.format(*cur,*nxt)
+            prev_frame = curr_frame = prev_frame + GRADIENT_TEMPLATE.format(*cur, *nxt)
 
         else:
             nxt = 0, 0, 0
-            prev= cur
+            prev = cur
             curr_frame += GRADIENT_TEMPLATE.format(*cur, *nxt)
         i += 1
         yield curr_frame
@@ -249,6 +249,8 @@ def __init__(
         self.start_time = None
         self.list = bartype(length, **kwargs).frames
         self.item_name = item_name
+        self.eta = None
+        self.percentage = None
         self.spinner = Spinner(spinner, speed=spinner_speed)
         self.percentage_fg_color = percentage_fg_color
         self.spinner_fg_color = spinner_fg_color
@@ -292,9 +294,11 @@ def update(self):
             self.percentage = (self.items_done / self.items) * 100
             iterations = self.items_done / (time.time() - self.start_time)
             self.eta = round((self.items - self.items_done) / iterations)
-            string = f"\r  {color_fg(self.spinner_fg_color)}{color_bg(self.spinner_bg_color)}{sf}{sfpad}{END}"+\
-            f"<{self.items_done}/{self.items}> {color_fg(self.percentage_fg_color)}{color_bg(self.percentage_bg_color)}{self.percentage:.1f}%{END}"+\
-            f"|{image}| ({iterations:.2f} {self.item_name}/s) ({self.eta//60:0>2}:{self.eta%60:0>2}eta)     "
+            string = (
+                f"\r  {color_fg(self.spinner_fg_color)}{color_bg(self.spinner_bg_color)}{sf}{sfpad}{END}"
+                + f"<{self.items_done}/{self.items}> {color_fg(self.percentage_fg_color)}{color_bg(self.percentage_bg_color)}{self.percentage:.1f}%{END}"
+                + f"|{image}| ({iterations:.2f} {self.item_name}/s) ({self.eta//60:0>2}:{self.eta%60:0>2}eta)     "
+            )
 
             sys.stdout.write(string)
             sys.stdout.flush()

build/dist/fancybar-0.2.0-py3-none-any.whl

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fancybar
-Version: 0.1.3
+Version: 0.2.0
 Summary: A highly customizable terminal progress bar library
 Home-page: https://github.com/jenca-adam/fancybar
 Author: Adam Jenca
@@ -81,7 +81,7 @@ There are currently the following bar types:
 
 - classic
 
-  .. image:: https://fancybar.readthedocs.io/en/latest/_images/bartype_classic.gif
+  .. image:https://fancybar.readthedocs.io/en/latest/_images/colors.gif: https://fancybar.readthedocs.io/en/latest/_images/bartype_classic.gif
 
   This bar type uses character '#' (U+0023 NUMBER SIGN) and filler ' ' (U+0020 SPACE). 
   This bar type should work on any terminal.
@@ -233,6 +233,16 @@ RGB tuples must be in format 0-255 and must not contain alpha part.
 RGB tuples are only supported in Truecolor terminals.
 They might display differently/incorrectly in other terminals.
 
+Runtime attributes
+==================
+
+While your bar is running, you can easily access some of its attributes:
+
+- ``ProgressBar.eta`` - current ETA in seconds 
+- ``ProgressBar.percentage`` - current percentage
+- ``ProgressBar.items_done`` - number of items already done
+
+
 
 .. |spinner-line| image:: line-spinner.gif
 

build/dist/fancybar-0.2.0.tar.gz

@@ -3,7 +3,7 @@
 setuptools.setup(
     name="fancybar",
     description="A highly customizable terminal progress bar library",
-    version="0.1.3",
+    version="0.2.0",
     long_description="""
 
 .. figure:: https://fancybar.readthedocs.io/en/latest/_images/fancybar-logo.png
@@ -69,7 +69,7 @@
 
 - classic
   
-  .. image:: https://fancybar.readthedocs.io/en/latest/_images/bartype_classic.gif
+  .. image:https://fancybar.readthedocs.io/en/latest/_images/colors.gif: https://fancybar.readthedocs.io/en/latest/_images/bartype_classic.gif
 
   This bar type uses character '#' (U+0023 NUMBER SIGN) and filler ' ' (U+0020 SPACE). 
   This bar type should work on any terminal.
@@ -221,6 +221,16 @@
 RGB tuples are only supported in Truecolor terminals.
 They might display differently/incorrectly in other terminals.
 
+Runtime attributes
+==================
+
+While your bar is running, you can easily access some of its attributes:
+
+- ``ProgressBar.eta`` - current ETA in seconds 
+- ``ProgressBar.percentage`` - current percentage
+- ``ProgressBar.items_done`` - number of items already done
+
+
 
 .. |spinner-line| image:: line-spinner.gif
 

build/fancybar.egg-info/PKG-INFO

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 6d620043fc3ea0de1ce1389126ddb08c
+config: 9a70ab5e65c746a4da81ba1ae409dc56
 tags: 645f666f9bcd5a90fca523b33c5a78b7

build/setup.py

@@ -168,7 +168,7 @@ Spinners
 .. image:: spinners.gif
 
 All spinners are on the GIF above.
-The spinners not shown are not shown because of the asciinema charset limitations. To get a more acute representation of the spinners, clone the repository and run ``python3 spinner_test.py``.
+The spinners not shown are not shown because of the asciinema charset limitations. To get a more acute representation of the spinners, clone the repository and run ``python3 showcases/spinner_test.py``.
 The default spinner is |spinner-line|.
 You can choose a spinner by setting the argument ``spinner`` of ``ProgressBar`` to its name. See :ref:`Entry Points`
 
@@ -237,5 +237,14 @@ RGB tuples must be in format 0-255 and must not contain alpha part.
 RGB tuples are only supported in Truecolor terminals.
 They might display differently/incorrectly in other terminals.
 
+Runtime attributes
+==================
+
+While your bar is running, you can easily access some of its attributes:
+
+- ``ProgressBar.eta`` - current ETA in seconds 
+- ``ProgressBar.percentage`` - current percentage
+- ``ProgressBar.items_done`` - number of items already done
+
 
 .. |spinner-line| image:: line-spinner.gif