pycoolprogressbar 0.1.0__py3-none-any.whl

pycoolprogressbar/__init__.py

@@ -0,0 +1,117 @@
+from yet_another_ansi_lib import ansi as nc
+from sys import stdout
+from shutil import get_terminal_size
+import time
+from typing import Literal
+
+COLORS_LIST = list(nc.ANSI_CODES)
+
+COLORS = Literal[
+    'black', 'red', 'green', 'yellow', 'blue', 'purple', 'cyan', 'white',
+    'intense_black', 'intense_red', 'intense_green', 'intense_yellow',
+    'intense_blue', 'intense_purple', 'intense_cyan', 'intense_white',
+    'bg_black', 'bg_red', 'bg_green', 'bg_yellow', 'bg_blue', 'bg_purple', 'bg_cyan', 'bg_white',
+    'bg_intense_black', 'bg_intense_red', 'bg_intense_green', 'bg_intense_yellow',
+    'bg_intense_blue', 'bg_intense_purple', 'bg_intense_cyan', 'bg_intense_white',
+    'bold', 'underline', 'italic', 'strikethrough', 'blink', 'reverse', 'hidden', 'dim',
+]
+
+class CoolBar:
+    def __init__(self, total, width=40, color:COLORS='intense_green', fill='█', empty='░', prefix='', suffix='', start=0, done_msg='', under_msg='', over_msg='', spinner_func=None, spinner_max_frames=None, unit='it'):
+        self.total = total
+        self.width = width
+        self.color = color
+        self.fill = fill
+        self.empty = empty
+        self.current = start
+        self.prefix = prefix
+        self.suffix = suffix
+        self.done_msg = done_msg
+        self.under_msg = under_msg
+        self.over_msg = over_msg
+        self.spinner_func = spinner_func
+        self.spinner_max_frames = spinner_max_frames
+        self.spinner_frames = -1
+        self.spinner = ''
+        self.unit = unit
+
+        self.start_time = time.time()
+        self.last_update_time = self.start_time
+        self.update_count = 0
+        self.speed = 0.0
+        self.eta = 0.0
+
+    def update(self, n=1):
+        self.current = min(self.current + n, self.total)
+
+        now = time.time()
+        elapsed = now - self.start_time
+        if elapsed > 0:
+            self.speed = self.current / elapsed
+            remaining = self.total - self.current
+            self.eta = remaining / self.speed if self.speed > 0 else 0
+
+        self._render()
+
+    def _format_time(seconds):
+        if seconds < 60:
+            return f"{seconds:.0f}s"
+        elif seconds < 3600:
+            return f"{seconds/60:.0f}m {seconds%60:.0f}s"
+        else:
+            return f"{seconds/3600:.1f}h"
+
+    def _render(self):
+        if self.spinner_func is not None:
+            self.spinner_frames += 1
+            if self.spinner_max_frames is not None:
+                self.spinner_frames = self.spinner_frames % self.spinner_max_frames
+            self.spinner = self.spinner_func(self.spinner_frames)
+        if self.total == 0:
+            percent = 100.0
+            filled = self.width
+        else:
+            percent = self.current / self.total * 100
+            filled = int(self.width * self.current / self.total)
+        bar = self.fill * filled + self.empty * (self.width - filled)
+        if self.current > self.total:
+            bar = f'{self.current}{self.unit}'
+        colored_bar = nc.style(bar, self.color)
+        speed_str = f"{self.speed:.1f} {self.unit}/s"
+        eta_str = self._format_time(self.eta) if self.eta > 0 else "∞"
+        line = f"\r{self.prefix}: {colored_bar} {percent:3.0f}% | {self.spinner} {self.suffix} | {speed_str} | ETA: {eta_str}"
+        cols = get_terminal_size().columns
+        line = line.ljust(cols)
+
+        stdout.write(line)
+        stdout.flush()
+
+    def _finish(self):
+        if self.current == self.total:
+            print(f'{self.done_msg}')
+        elif self.current > self.total:
+            print(f'{self.over_msg}')
+        else:
+            print(f'{self.under_msg}')
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self._finish()
+
+    def __call__(self, n=1):
+        self.update(n)
+
+    def __iter__(self):
+        self.current = 0
+        self._render()
+        return self
+
+    def __next__(self):
+        if self.current >= self.total:
+            raise StopIteration
+        self.update(1)
+        return self.current
+
+__all__ = ['CoolBar', 'COLORS']

pycoolprogressbar-0.1.0.dist-info/METADATA

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: pycoolprogressbar
+Version: 0.1.0
+Summary: Progress bars with cool ANSI styling! and more!
+Author: robert-ish
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/robert-ish/coolbar
+Project-URL: Repository, https://github.com/robert-ish/coolbar
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: yet-another-ansi-lib>=0.1.1
+Dynamic: license-file
+
+# coolbar
+Aims to be the ultimate progress bar package for python.  
+(But i dont believe in myself so it fails)
+## Installation
+```bash
+pip install pycoolprogressbar
+```
+## Usage
+```python
+from pycoolprogressbar import CoolBar
+import time
+for i in CoolBar(100):
+    time.sleep(0.02)
+```
+## CoolBar class
+This is the main class for everything
+It can be used as an iterable or as a context manager
+### __init__ (creating the instance):
+This can be kinda confusing?
+args:
+total: the maximum value of the progress bar. Can be overshot.
+width: the length of the progress bar, in characters.
+color: must be a color from the COLORS_LIST
+fill: changes the character displayed for filled segments.
+empty: changes the character displayed for unfilled segments.
+prefix: displayed in the bar before the bar. use as a title (eg.: "Loading")
+suffix: displayed after the bar but before everything else, surprisingly. Could use to describe what you're doing
+start: what value the bar starts from.
+done_msg: printed when bar ends with no errors
+under_msg: printed when the bar ends without reaching total.
+over_msg: printed when the bar ends with current being more than total.
+spinner_func: used to add a spinner to the bar. It should be a function, and you should preferably add limiting frames yourself
+spinner_max_frames: additional frame limit. it should be how much frames you have - 1
+unit: what is displayed when overshot and in the speed counter.
+### CoolBar.update(n)
+Adds n to the instances current count.
+This is also called when calling the coolbar class itself
+Can overshoot total.
+## License
+MIT

pycoolprogressbar-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+pycoolprogressbar/__init__.py,sha256=BslA54l70KSU6a0-Rae6y6Y6EXmKu4jdI-wH1wawPQU,4179
+pycoolprogressbar-0.1.0.dist-info/licenses/LICENSE,sha256=4hEXM7QJl6WNEeOeGvDsIsm7de04VXhKjs1l756Wcvw,1086
+pycoolprogressbar-0.1.0.dist-info/METADATA,sha256=ArhTO7qMdipbJtIzZ_pI6ut8_Orv9mqv6I_h0mqHGt8,2181
+pycoolprogressbar-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+pycoolprogressbar-0.1.0.dist-info/top_level.txt,sha256=qBi_cdCIpRKv_N-J7MFYdpJLfNeSwfH20saicOF8byg,18
+pycoolprogressbar-0.1.0.dist-info/RECORD,,

pycoolprogressbar-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pycoolprogressbar-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 robert-ish
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pycoolprogressbar-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pycoolprogressbar